From c6c4ef1a072c4b3437547f8270bea19a6bbcd187 Mon Sep 17 00:00:00 2001 From: Pramod Kumbhar Date: Tue, 17 Dec 2024 10:27:36 +0100 Subject: [PATCH 1/2] Combine README.md and README.rst --- README.md | 22 ---------------------- README.rst | 31 +++++++++++++++++++------------ 2 files changed, 19 insertions(+), 34 deletions(-) delete mode 100644 README.md diff --git a/README.md b/README.md deleted file mode 100644 index a4f885fee..000000000 --- a/README.md +++ /dev/null @@ -1,22 +0,0 @@ -# The NMODL Framework - -> [!WARNING] -> -> NMODL has been fully integrated into the NEURON repository. There will -> be no further development efforts NMODL as an independent project. -> -> All future development will happen at: -> https://github.com/neuronsimulator/nrn - -## Funding & Acknowledgment - -The development of this software was supported by funding to the Blue -Brain Project, a research center of the École polytechnique fédérale de -Lausanne (EPFL), from the Swiss government’s ETH Board of the Swiss -Federal Institutes of Technology. In addition, the development was -supported by funding from the National Institutes of Health (NIH) under -the Grant Number R01NS11613 (Yale University) and the European Union’s -Horizon 2020 Framework Programme for Research and Innovation under the -Specific Grant Agreement No. 785907 (Human Brain Project SGA2). - -Copyright © 2017-2024 Blue Brain Project, EPFL diff --git a/README.rst b/README.rst index 08ee4ef94..c1b9bcc49 100644 --- a/README.rst +++ b/README.rst @@ -1,7 +1,14 @@ The NMODL Framework =================== -|github workflow| |Build Status| |codecov| |CII Best Practices| +> [!WARNING] +> +> NMODL has been fully integrated into the NEURON repository. There will +> be no further development efforts NMODL as an independent project. +> +> All future development will happen at: +> https://github.com/neuronsimulator/nrn + The NMODL Framework is a code generation engine for **N**\ EURON **MOD**\ eling **L**\ anguage @@ -137,7 +144,7 @@ API to load NMOD file as: from nmodl import dsl - examples = dsl.list_examples() + examples = dsl.list_examples() nmodl_string = dsl.load_example(examples[-1]) driver = dsl.NmodlDriver() modast = driver.parse_string(nmodl_string) @@ -328,7 +335,15 @@ Citation -------- If you would like to know more about the the NMODL Framework, see -following paper: +the following paper: + +- Pramod Kumbhar, Omar Awile, Liam Keegan, Jorge Blanco Alonso, James King, + Michael Hines, and Felix Schürmann. 2020. An optimizing multi-platform + source-to-source compiler framework for the NEURON MODeling Language. + In *Computational Science – ICCS 2020*, Springer, Cham, 45–58. + DOI: [`10.1007/978-3-030-50371-0_4`](https://doi.org/10.1007/978-3-030-50371-0_4) + +Some additional details are covered in the pre-print: - Pramod Kumbhar, Omar Awile, Liam Keegan, Jorge Alonso, James King, Michael Hines and Felix Schürmann. 2019. An optimizing multi-platform @@ -367,12 +382,4 @@ the Grant Number R01NS11613 (Yale University) and the European Union’s Horizon 2020 Framework Programme for Research and Innovation under the Specific Grant Agreement No. 785907 (Human Brain Project SGA2). -Copyright © 2017-2023 Blue Brain Project, EPFL - -.. |github workflow| image:: https://github.com/BlueBrain/nmodl/actions/workflows/nmodl-ci.yml/badge.svg?branch=master -.. |Build Status| image:: https://dev.azure.com/pramodskumbhar/nmodl/_apis/build/status/BlueBrain.nmodl?branchName=master - :target: https://dev.azure.com/pramodskumbhar/nmodl/_build/latest?definitionId=2&branchName=master -.. |codecov| image:: https://codecov.io/gh/BlueBrain/nmodl/branch/master/graph/badge.svg?token=A3NU9VbNcB - :target: https://codecov.io/gh/BlueBrain/nmodl -.. |CII Best Practices| image:: https://bestpractices.coreinfrastructure.org/projects/4467/badge - :target: https://bestpractices.coreinfrastructure.org/projects/4467 +Copyright © 2017-2024 Blue Brain Project, EPFL From 36617e6270aa5d21d0154dfe08dc16cc47da1582 Mon Sep 17 00:00:00 2001 From: Pramod Kumbhar Date: Tue, 17 Dec 2024 10:42:50 +0100 Subject: [PATCH 2/2] format update --- README.rst | 18 ++++++++++-------- 1 file changed, 10 insertions(+), 8 deletions(-) diff --git a/README.rst b/README.rst index c1b9bcc49..059e9b901 100644 --- a/README.rst +++ b/README.rst @@ -1,14 +1,16 @@ The NMODL Framework =================== -> [!WARNING] -> -> NMODL has been fully integrated into the NEURON repository. There will -> be no further development efforts NMODL as an independent project. -> -> All future development will happen at: -> https://github.com/neuronsimulator/nrn +WARNING +_______ +**NMODL has been fully integrated into the NEURON repository.** +There will be no further development efforts on NMODL as an independent project. + +All future development will happen at: +`https://github.com/neuronsimulator/nrn `_. + +--------------------- The NMODL Framework is a code generation engine for **N**\ EURON **MOD**\ eling **L**\ anguage @@ -341,7 +343,7 @@ the following paper: Michael Hines, and Felix Schürmann. 2020. An optimizing multi-platform source-to-source compiler framework for the NEURON MODeling Language. In *Computational Science – ICCS 2020*, Springer, Cham, 45–58. - DOI: [`10.1007/978-3-030-50371-0_4`](https://doi.org/10.1007/978-3-030-50371-0_4) + DOI: `10.1007/978-3-030-50371-0_4 `__ Some additional details are covered in the pre-print: