This repository has been archived by the owner on May 2, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
ba97c30
commit 8df8926
Showing
28 changed files
with
2,475 additions
and
989 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
.. mdinclude:: ../AUTHORS.md |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
.. mdinclude:: ../CONTRIBUTING.md |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
.. mdinclude:: ../HISTORY.md |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,20 +1,19 @@ | ||
.. No Errors Test Project documentation master file, created by | ||
sphinx-quickstart on Fri Aug 30 17:07:56 2019. | ||
You can adapt this file completely to your liking, but it should at least | ||
contain the root `toctree` directive. | ||
Welcome to No Errors Test Project's documentation! | ||
================================================== | ||
Welcome to Icon Data Processing Incubator's documentation! | ||
=========================================================== | ||
|
||
.. toctree:: | ||
:maxdepth: 2 | ||
:caption: Hello World! | ||
|
||
:caption: Contents: | ||
|
||
readme | ||
installation | ||
usage | ||
modules | ||
contributing | ||
authors | ||
history | ||
|
||
Indices and tables | ||
================== | ||
|
||
* :ref:`genindex` | ||
* :ref:`modindex` | ||
* :ref:`search` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,78 @@ | ||
.. highlight:: shell | ||
|
||
============ | ||
Installation | ||
============ | ||
|
||
There are two installation types, a production installation, which is static, and a development installation, which is editable. | ||
|
||
|
||
Preparation | ||
----------- | ||
|
||
To install Icon Data Processing Incubator you need a miniconda installation. You can either set up your miniconda installation manually or use the script `tools/setup_miniconda.sh`, which will download and install the latest version of miniconda. | ||
|
||
|
||
Installation of dependencies | ||
---------------------------- | ||
|
||
Dependencies are handled by the conda package manager. The goal of this step is to set up a conda environment according to the requirements of Icon Data Processing Incubator. Note that by design, there are some dependencies already when you start developing the package, as the environment includes linters and other development tools. | ||
|
||
The dependencies are handled in requirement files. Free installations are based on the `requirements/requirements.yaml` file, where the top-level dependencies of the package are listed. Pinned installations are based on exported environments and stored in the file `requirements/environment.yaml`. | ||
|
||
Environments (based on either unpinned or pinned requirements) are handled by the script `tools/setup_env.sh`. The optional flag `-u` stands for unpinned installation: | ||
|
||
.. code-block:: console | ||
$ bash tools/setup_env.sh -u | ||
This will create an up-to-date environment that can be exported to `requirements/environment.yaml` with the optional flag `-e` (see below). | ||
|
||
You can control the environment name with the flag `-n` and the Python version with `-v`. Run :code:`./tools/setup_env -h` for available options and defaults (incl. mamba support). | ||
|
||
|
||
Installation of Icon Data Processing Incubator | ||
----------------------------------------------- | ||
|
||
After creating and activating your environment by running | ||
|
||
.. code-block:: console | ||
$ ./tools/setup_env.sh | ||
$ conda activate icon-data-processing-incubator | ||
in the root folder of icon-data-processing-incubator, type | ||
|
||
.. code-block:: console | ||
$ python -m pip install --no-deps . | ||
for a (static) production installation and | ||
|
||
.. code-block:: console | ||
$ pip install --no-deps --editable . | ||
for a (editable) development installation. | ||
|
||
|
||
Maintenance of the environment (for developers) | ||
----------------------------------------------- | ||
|
||
If you need to add new first-level dependencies to your package, make sure to include them in `requirements/requirements.yaml`. (Note that pip requirements can be added to these files in the `- pip:` section of the document.) After a (unpinned!) installation, this will change the full dependency tree and you need to export the environment. You can either do this by hand by activating the environment and then running | ||
|
||
.. code-block:: console | ||
$ conda env export icon-data-processing-incubator requirements/environment.yaml | ||
or you can reinstall with the setup script from `requirements/requirements.yaml` and directly export the environment with the `-e` flag. | ||
|
||
.. code-block:: console | ||
$ ./tools/setup_env -ue | ||
Interaction with Jenkins and Github actions | ||
------------------------------------------- | ||
|
||
Your package is always built on a Github actions server upon committing to the main branch. If your code goes into production, pinned production installations must be tested with Jenkins on CSCS machines. Templates may be found in the jenkins/ folder. Contact DevOps to help you set up your pipeline. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
======= | ||
Modules | ||
======= | ||
|
||
.. automodule:: idpi.mutable_number | ||
:members: |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
.. mdinclude:: ../README.md |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
.. mdinclude:: ../USAGE.md |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.