miniff issueshttps://gitlab.kwant-project.org/qt/miniff/-/issues2021-03-31T13:04:12Zhttps://gitlab.kwant-project.org/qt/miniff/-/issues/32Synchronize minimal package versions across different places2021-03-31T13:04:12ZArtem PulkinSynchronize minimal package versions across different placesThere are several places where package versions were specified:
1. ``environment.yml``
2. ``pyproject.toml``
3. ``.gitlab.ci``
4. ``requirements.txt``
5. condaThere are several places where package versions were specified:
1. ``environment.yml``
2. ``pyproject.toml``
3. ``.gitlab.ci``
4. ``requirements.txt``
5. condaNiket AgrawalNiket Agrawalhttps://gitlab.kwant-project.org/qt/miniff/-/issues/31Create a project handover documentation2021-03-30T09:16:38ZNiket AgrawalCreate a project handover documentationCreate a documentation for project handover purposes. This document will serve the purpose of a reference manual to the maintainer(s) of miniff. It shall provides the following information.
- Implementation and configuration details of ...Create a documentation for project handover purposes. This document will serve the purpose of a reference manual to the maintainer(s) of miniff. It shall provides the following information.
- Implementation and configuration details of certain aspects of the repository such as the documentation setup, versioning, packaging, CI and dependency management.
- Software development and maintenance workflow for miniff.
The aforementioned details will be captured in the Wiki of the miniff GitLab repositoryNiket AgrawalNiket Agrawalhttps://gitlab.kwant-project.org/qt/miniff/-/issues/30Remove patch version number pinning to facilitate receiving bug fixes for the...2021-03-09T09:37:17ZNiket AgrawalRemove patch version number pinning to facilitate receiving bug fixes for the packagesNot fixing the patch version number facilitates receiving bug fixes for individual packages by requirements.txt/env.yml and update the environment. The overall consistency is still maintained as the major and minor version numbers remain...Not fixing the patch version number facilitates receiving bug fixes for individual packages by requirements.txt/env.yml and update the environment. The overall consistency is still maintained as the major and minor version numbers remain fixed.Niket AgrawalNiket Agrawalhttps://gitlab.kwant-project.org/qt/miniff/-/issues/28Update installation instructions in README to include pip install miniff2021-02-23T09:53:42ZNiket AgrawalUpdate installation instructions in README to include pip install miniffNow that miniff is uploaded to PyPI, single command installation via pip, i.e., `pip install miniff` suffices for the end users who wish to install and use miniff, they need not set up a development environment explicitly which the curre...Now that miniff is uploaded to PyPI, single command installation via pip, i.e., `pip install miniff` suffices for the end users who wish to install and use miniff, they need not set up a development environment explicitly which the current README instructs to do. That is meant for developers who wish to contribute to miniff and is already covered in CONTRIBUTING.md.Niket AgrawalNiket Agrawalhttps://gitlab.kwant-project.org/qt/miniff/-/issues/27Add a changelog2021-02-15T13:25:27ZNiket AgrawalAdd a changelogAdd a changelog to keep an ordered history of changes in each version of miniffAdd a changelog to keep an ordered history of changes in each version of miniffNiket AgrawalNiket Agrawalhttps://gitlab.kwant-project.org/qt/miniff/-/issues/13Add CONTRIBUTING.md containing instructions for contributing to the code and ...2021-02-15T13:29:51ZNiket AgrawalAdd CONTRIBUTING.md containing instructions for contributing to the code and also the documentationAdd CONTRIBUTING.md containing instructions for contributing to the code and also the documentation. These instructions should be separated from the README.md and put explicitly in this file.Add CONTRIBUTING.md containing instructions for contributing to the code and also the documentation. These instructions should be separated from the README.md and put explicitly in this file.Niket AgrawalNiket Agrawalhttps://gitlab.kwant-project.org/qt/miniff/-/issues/10Add license2021-01-22T14:03:36ZNiket AgrawalAdd licenseAdd a license to facilitate software distribution, allow others to utilize this code, build on top of this code, etc.Add a license to facilitate software distribution, allow others to utilize this code, build on top of this code, etc.Anton AkhmerovAnton Akhmerovhttps://gitlab.kwant-project.org/qt/miniff/-/issues/9Dependency management for easy reproducibility2021-01-21T17:35:56ZNiket AgrawalDependency management for easy reproducibilityCurrently, the dependencies needs to be installed one by one and the steps are specific to pip users.
To Do:
1. Implement an approach for managing dependencies that make miniff environment reproducibility and installation convenient a...Currently, the dependencies needs to be installed one by one and the steps are specific to pip users.
To Do:
1. Implement an approach for managing dependencies that make miniff environment reproducibility and installation convenient and straightforward.
2. Update the Readme with the usage and installation instructions accordingly.Niket AgrawalNiket Agrawalhttps://gitlab.kwant-project.org/qt/miniff/-/issues/7Set up documentation infrastructure in the project2021-01-21T17:35:56ZNiket AgrawalSet up documentation infrastructure in the projectThe repository lacks documentation for the miniff project. A starting point can be to setup a sphnix based documentation infrastructure that renders the documentation in html and that can be integrated in the Gitlab CI so that documentat...The repository lacks documentation for the miniff project. A starting point can be to setup a sphnix based documentation infrastructure that renders the documentation in html and that can be integrated in the Gitlab CI so that documentation is built on each commit. Jupyter-sphinx extension can be considered so that jupyter notebooks in future can also be converted to documentation directly.Niket AgrawalNiket Agrawal