You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+11-11Lines changed: 11 additions & 11 deletions
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
-
# Contributing to `BioSimulators-PyNeuroML`
1
+
# Contributing to `BioSimulators-pyNeuroML`
2
2
3
-
We enthusiastically welcome contributions to BioSimulators-PyNeuroML!
3
+
We enthusiastically welcome contributions to BioSimulators-pyNeuroML!
4
4
5
5
## Coordinating contributions
6
6
@@ -11,30 +11,30 @@ Before getting started, please contact the lead developers at [info@biosimulator
11
11
The repository follows standard Python conventions:
12
12
13
13
*`README.md`: Overview of the repository
14
-
*`biosimulators_pyneuroml/`: Python code for a BioSimulators-compliant command-line interface to PyNeuroML
14
+
*`biosimulators_pyneuroml/`: Python code for a BioSimulators-compliant command-line interface to pyNeuroML
15
15
*`tests/`: unit tests for the command-line interface
16
16
*`setup.py`: installation script for the command-line interface
17
17
*`setup.cfg`: configuration for the installation of the command-line interface
18
18
*`requirements.txt`: dependencies for the command-line interface
19
19
*`requirements.optional.txt`: optional dependencies for the command-line interface
20
20
*`MANIFEST.in`: a list of files to include in the package for the command-line interface
21
21
*`LICENSE`: License
22
-
*`CONTRIBUTING.md`: Guide to contributing to BioSimulators-PyNeuroML (this document)
23
-
*`CODE_OF_CONDUCT.md`: Code of conduct for developers of BioSimulators-PyNeuroML
22
+
*`CONTRIBUTING.md`: Guide to contributing to BioSimulators-pyNeuroML (this document)
23
+
*`CODE_OF_CONDUCT.md`: Code of conduct for developers of BioSimulators-pyNeuroML
24
24
25
25
## Coding convention
26
26
27
-
BioSimulators-PyNeuroML follows standard Python style conventions:
27
+
BioSimulators-pyNeuroML follows standard Python style conventions:
28
28
29
29
* Class names: `UpperCamelCase`
30
30
* Function names: `lower_snake_case`
31
31
* Variable names: `lower_snake_case`
32
32
33
33
## Testing and continuous integration
34
34
35
-
We strive to have complete test coverage for BioSimulators-PyNeuroML.
35
+
We strive to have complete test coverage for BioSimulators-pyNeuroML.
36
36
37
-
The unit tests for BioSimulators-PyNeuroML are located in the `tests` directory. The tests can be executed by running the following command:
37
+
The unit tests for BioSimulators-pyNeuroML are located in the `tests` directory. The tests can be executed by running the following command:
38
38
```
39
39
pip install pytest
40
40
python -m pytest tests
@@ -51,7 +51,7 @@ coverage html
51
51
52
52
## Documentation convention
53
53
54
-
BioSimulators-PyNeuroML is documented using [reStructuredText](https://www.sphinx-doc.org/en/master/usage/restructuredtext/index.html) and the [napoleon Sphinx plugin](https://www.sphinx-doc.org/en/master/usage/extensions/napoleon.html). The documentation can be compiled by running the following commands:
54
+
BioSimulators-pyNeuroML is documented using [reStructuredText](https://www.sphinx-doc.org/en/master/usage/restructuredtext/index.html) and the [napoleon Sphinx plugin](https://www.sphinx-doc.org/en/master/usage/extensions/napoleon.html). The documentation can be compiled by running the following commands:
@@ -87,8 +87,8 @@ Below are instructions for releasing a new version:
87
87
88
88
## Reporting issues
89
89
90
-
Please use [GitHub issues](https://github.com/biosimulators/Biosimulators_PyNeuroML/issues) to report any issues to the development community.
90
+
Please use [GitHub issues](https://github.com/biosimulators/Biosimulators_pyNeuroML/issues) to report any issues to the development community.
91
91
92
92
## Getting help
93
93
94
-
Please use [GitHub issues](https://github.com/biosimulators/Biosimulators_PyNeuroML/issues) to post questions or contact the lead developers at [[email protected]](mailto:[email protected]).
94
+
Please use [GitHub issues](https://github.com/biosimulators/Biosimulators_pyNeuroML/issues) to post questions or contact the lead developers at [[email protected]](mailto:[email protected]).
BioSimulators-compliant command-line interface and Docker image for the [PyNeuroML](https://github.com/NeuroML/pyNeuroML) simulation program.
6
+
# BioSimulators-pyNeuroML
7
+
BioSimulators-compliant command-line interface and Docker image for the [pyNeuroML](https://github.com/NeuroML/pyNeuroML) simulation program.
8
8
9
-
This command-line interface and Docker image enable users to use PyNeuroML to execute [COMBINE/OMEX archives](https://combinearchive.org/) that describe one or more simulation experiments (in [SED-ML format](https://sed-ml.org)) of one or more models (in [NeuroML format](https://neuroml.org/])).
9
+
This command-line interface and Docker image enable users to use pyNeuroML to execute [COMBINE/OMEX archives](https://combinearchive.org/) that describe one or more simulation experiments (in [SED-ML format](https://sed-ml.org)) of one or more models (in [NeuroML format](https://neuroml.org/])).
10
10
11
-
A list of the algorithms and algorithm parameters supported by PyNeuroML is available at [BioSimulators](https://biosimulators.org/simulators/pyneuroml).
11
+
A list of the algorithms and algorithm parameters supported by pyNeuroML is available at [BioSimulators](https://biosimulators.org/simulators/pyneuroml).
12
12
13
-
A simple web application and web service for using PyNeuroML to execute COMBINE/OMEX archives is also available at [runBioSimulations](https://run.biosimulations.org).
13
+
A simple web application and web service for using pyNeuroML to execute COMBINE/OMEX archives is also available at [runBioSimulations](https://run.biosimulations.org).
0 commit comments