Skip to content

Commit 85f3477

Browse files
committed
correcting capitalization of pyNeuroML
1 parent 407d8a4 commit 85f3477

File tree

7 files changed

+34
-34
lines changed

7 files changed

+34
-34
lines changed

CONTRIBUTING.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# Contributing to `BioSimulators-PyNeuroML`
1+
# Contributing to `BioSimulators-pyNeuroML`
22

3-
We enthusiastically welcome contributions to BioSimulators-PyNeuroML!
3+
We enthusiastically welcome contributions to BioSimulators-pyNeuroML!
44

55
## Coordinating contributions
66

@@ -11,30 +11,30 @@ Before getting started, please contact the lead developers at [info@biosimulator
1111
The repository follows standard Python conventions:
1212

1313
* `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
1515
* `tests/`: unit tests for the command-line interface
1616
* `setup.py`: installation script for the command-line interface
1717
* `setup.cfg`: configuration for the installation of the command-line interface
1818
* `requirements.txt`: dependencies for the command-line interface
1919
* `requirements.optional.txt`: optional dependencies for the command-line interface
2020
* `MANIFEST.in`: a list of files to include in the package for the command-line interface
2121
* `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
2424

2525
## Coding convention
2626

27-
BioSimulators-PyNeuroML follows standard Python style conventions:
27+
BioSimulators-pyNeuroML follows standard Python style conventions:
2828

2929
* Class names: `UpperCamelCase`
3030
* Function names: `lower_snake_case`
3131
* Variable names: `lower_snake_case`
3232

3333
## Testing and continuous integration
3434

35-
We strive to have complete test coverage for BioSimulators-PyNeuroML.
35+
We strive to have complete test coverage for BioSimulators-pyNeuroML.
3636

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:
3838
```
3939
pip install pytest
4040
python -m pytest tests
@@ -51,7 +51,7 @@ coverage html
5151

5252
## Documentation convention
5353

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:
5555

5656
```
5757
python -m pip install -r docs-src/requirements.txt
@@ -87,8 +87,8 @@ Below are instructions for releasing a new version:
8787

8888
## Reporting issues
8989

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.
9191

9292
## Getting help
9393

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]).

Dockerfile

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,12 @@ ARG SIMULATOR_VERSION="0.5.11"
66

77
# metadata
88
LABEL \
9-
org.opencontainers.image.title="PyNeuroML" \
9+
org.opencontainers.image.title="pyNeuroML" \
1010
org.opencontainers.image.version="${SIMULATOR_VERSION}" \
1111
org.opencontainers.image.description="Python package for reading, writing, simulating and analysing NeuroML2/LEMS models" \
1212
org.opencontainers.image.url="https://github.com/NeuroML/pyNeuroML" \
1313
org.opencontainers.image.documentation="https://github.com/NeuroML/pyNeuroML/" \
14-
org.opencontainers.image.source="https://github.com/biosimulators/Biosimulators_PyNeuroML" \
14+
org.opencontainers.image.source="https://github.com/biosimulators/Biosimulators_pyNeuroML" \
1515
org.opencontainers.image.authors="BioSimulators Team <[email protected]>" \
1616
org.opencontainers.image.vendor="BioSimulators Team" \
1717
org.opencontainers.image.licenses="LGPL-3.0-only" \
@@ -36,9 +36,9 @@ RUN apt-get update -y \
3636
&& rm -rf /var/lib/apt/lists/*
3737

3838
# Copy code for command-line interface into image and install it
39-
COPY . /root/Biosimulators_PyNeuroML
40-
RUN pip install /root/Biosimulators_PyNeuroML \
41-
&& rm -rf /root/Biosimulators_PyNeuroML
39+
COPY . /root/Biosimulators_pyNeuroML
40+
RUN pip install /root/Biosimulators_pyNeuroML \
41+
&& rm -rf /root/Biosimulators_pyNeuroML
4242
RUN pip install "pyneuroml==${SIMULATOR_VERSION}"
4343
ENV VERBOSE=0 \
4444
MPLBACKEND=PDF

README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
1-
[![Latest release](https://img.shields.io/github/v/tag/biosimulators/Biosimulators_PyNeuroML)](https://github.com/biosimulations/Biosimulators_PyNeuroML/releases)
1+
[![Latest release](https://img.shields.io/github/v/tag/biosimulators/Biosimulators_pyNeuroML)](https://github.com/biosimulations/Biosimulators_pyNeuroML/releases)
22
[![PyPI](https://img.shields.io/pypi/v/biosimulators_pyneuroml)](https://pypi.org/project/biosimulators_pyneuroml/)
3-
[![CI status](https://github.com/biosimulators/Biosimulators_PyNeuroML/workflows/Continuous%20integration/badge.svg)](https://github.com/biosimulators/Biosimulators_PyNeuroML/actions?query=workflow%3A%22Continuous+integration%22)
4-
[![Test coverage](https://codecov.io/gh/biosimulators/Biosimulators_PyNeuroML/branch/dev/graph/badge.svg)](https://codecov.io/gh/biosimulators/Biosimulators_PyNeuroML)
3+
[![CI status](https://github.com/biosimulators/Biosimulators_pyNeuroML/workflows/Continuous%20integration/badge.svg)](https://github.com/biosimulators/Biosimulators_pyNeuroML/actions?query=workflow%3A%22Continuous+integration%22)
4+
[![Test coverage](https://codecov.io/gh/biosimulators/Biosimulators_pyNeuroML/branch/dev/graph/badge.svg)](https://codecov.io/gh/biosimulators/Biosimulators_pyNeuroML)
55

6-
# BioSimulators-PyNeuroML
7-
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.
88

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/])).
1010

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).
1212

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).
1414

1515
## Installation
1616

@@ -33,7 +33,7 @@ docker pull ghcr.io/biosimulators/pyneuroml
3333
```
3434
usage: pyneuroml [-h] [-d] [-q] -i ARCHIVE [-o OUT_DIR] [-v]
3535
36-
BioSimulators-compliant command-line interface to the PyNeuroML <https://github.com/NeuroML/pyNeuroML> simulation program.
36+
BioSimulators-compliant command-line interface to the pyNeuroML <https://github.com/NeuroML/pyNeuroML> simulation program.
3737
3838
optional arguments:
3939
-h, --help show this help message and exit
@@ -64,7 +64,7 @@ docker run \
6464
```
6565

6666
## Documentation
67-
Documentation is available at https://biosimulators.github.io/Biosimulators_PyNeuroML/.
67+
Documentation is available at https://biosimulators.github.io/Biosimulators_pyNeuroML/.
6868

6969
## License
7070
This package is released under the [MIT](LICENSE).

biosimulators_pyneuroml/__main__.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
""" BioSimulators-compliant command-line interface to the `PyNeuroML <https://github.com/NeuroML/pyNeuroML>`_ simulation program.
1+
""" BioSimulators-compliant command-line interface to the `pyNeuroML <https://github.com/NeuroML/pyNeuroML>`_ simulation program.
22
33
:Author: Jonathan Karr <[email protected]>
44
:Date: 2021-05-28
@@ -12,7 +12,7 @@
1212
import pyneuroml
1313

1414
App = build_cli('pyneuroml', __version__,
15-
'PyNeuroML', pyneuroml.__version__, 'https://github.com/NeuroML/pyNeuroML',
15+
'pyNeuroML', pyneuroml.__version__, 'https://github.com/NeuroML/pyNeuroML',
1616
exec_sedml_docs_in_combine_archive)
1717

1818

biosimulators_pyneuroml/core.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
""" Methods for using PyNeuroML to execute SED tasks in COMBINE archives and save their outputs
1+
""" Methods for using pyNeuroML to execute SED tasks in COMBINE archives and save their outputs
22
33
:Author: Jonathan Karr <[email protected]>
44
:Date: 2021-05-28
@@ -157,7 +157,7 @@ def exec_sed_task(task, variables, log=None):
157157
])
158158
warn(msg, BioSimulatorsWarning)
159159

160-
# Validate that start time is 0 because this is the only option that PyNeuroML supports
160+
# Validate that start time is 0 because this is the only option that pyNeuroML supports
161161
if simulation.initial_time != 0:
162162
raise NotImplementedError('Initial simulation time {} is not supported. Initial time must be 0.'.format(simulation.initial_time))
163163

biosimulators_pyneuroml/data_model.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
""" Data model for PyNeuroML algorithms and their parameters
1+
""" Data model for pyNeuroML algorithms and their parameters
22
33
:Author: Jonathan Karr <[email protected]>
44
:Date: 2021-05-28

setup.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -26,10 +26,10 @@
2626
name=name,
2727
version=md.version,
2828
description=("BioSimulators-compliant command-line interface to "
29-
"the PyNeuroML simulation program."),
29+
"the pyNeuroML simulation program."),
3030
long_description=md.long_description,
31-
url="https://github.com/biosimulators/Biosimulators_PyNeuroML",
32-
download_url="https://github.com/biosimulators/Biosimulators_PyNeuroML",
31+
url="https://github.com/biosimulators/Biosimulators_pyNeuroML",
32+
download_url="https://github.com/biosimulators/Biosimulators_pyNeuroML",
3333
author='BioSimulators Team',
3434
author_email="[email protected]",
3535
license="MIT",

0 commit comments

Comments
 (0)