|
|
## Miniff usage overview
|
|
|
|
|
|
- End users who simply wish to use miniff will install miniff via the command `pip install miniff`. This single command installation will install miniff and its dependencies.
|
|
|
- End users who wish to use miniff will install miniff via the command `pip install miniff`. This single command installation will install miniff and its dependencies.
|
|
|
|
|
|
- Potential contributors who wish to contribute new features, documentation or fix bugs will need to set up a development environment and install miniff in development mode. This procedure is explained in [CONTRIBUTING.md](https://gitlab.kwant-project.org/qt/miniff/-/blob/master/CONTRIBUTING.md#set-up-a-local-miniff-development-environment).
|
|
|
|
... | ... | @@ -75,7 +75,6 @@ A new DOI will be generated for each new version of the software that will be ar |
|
|
|
|
|
|
|
|
## Dependency management
|
|
|
(Under construction ...)
|
|
|
|
|
|
The dependencies of miniff are captured in the following files.
|
|
|
|
... | ... | @@ -87,9 +86,9 @@ The dependencies of miniff are captured in the following files. |
|
|
|
|
|
* **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.
|
|
|
|
|
|
* **gitlab-ci.yml** - Upon every push to the master, CI tests the code against the minimal working version and latest version of the dependencies.
|
|
|
* **gitlab-ci.yml** - Upon every push to the master, CI tests the code against the minimal working version and latest version of the dependencies. In the future, to verify the functionality of miniff and keep it updated with the latest version of the dependencies, a scheduled CI execution can be set up.
|
|
|
|
|
|
The minimum working versions of the dependencies are listed in the above 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.**
|
|
|
|
... | ... | |