... | ... | @@ -82,7 +82,7 @@ The dependencies of miniff are captured in the following files. |
|
|
|
|
|
* *pyproject.toml* captures the build requirements
|
|
|
|
|
|
* *requirements.txt* and **environment.yml** files in the root directory - These files are provided to facilitate replicating miniff development environment for pip and conda users respectively who wish to work from source. In addition to the core dependencies, these files contain development only dependencies such as nosetest, sphinx, etc.
|
|
|
* *requirements.txt* and *environment.yml* files in the root directory - These files are provided to facilitate replicating miniff development environment for pip and conda users respectively who wish to work from source. In addition to the core dependencies, these files contain development only dependencies such as nosetest, sphinx, etc.
|
|
|
|
|
|
* *docs/requirements.txt* - Dependencies for building the documentation. This file is utilized by Read the Docs to build the documentation as explained earlier in the Read the Docs configuration section.
|
|
|
|
... | ... | @@ -90,7 +90,7 @@ The dependencies of miniff are captured in the following files. |
|
|
|
|
|
* The version of the dependencies in the above files is loosely pinned, only the lower limit for the version of the dependencies is specified, for example, numpy>=1.18.4
|
|
|
|
|
|
**In the event when the dependencies needs to be updated in the case of addition/removal of any dependency or version update, the change should reflect in all the above files.**
|
|
|
**When the dependencies needs to be updated in the case of addition/removal of any dependency or version update, the change should reflect in all the above files and be consistent.**
|
|
|
|
|
|
|
|
|
## Software versioning and Release management
|
... | ... | @@ -138,7 +138,7 @@ git tag -a x.y.z -m "release note" |
|
|
git push origin x.y.z
|
|
|
```
|
|
|
|
|
|
* Upload the new version to PyPI and Zenodo following the steps lised in the sections Packaging miniff and uploading to PyPI and software citation respectively.
|
|
|
* Upload the new version to PyPI and Zenodo following the steps listed in the sections Packaging miniff and uploading to PyPI and software citation respectively.
|
|
|
|
|
|
## Support for Windows users
|
|
|
(To add ...) |