-
Notifications
You must be signed in to change notification settings - Fork 7
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Final improvement docs to v1.0 (#214)
- Loading branch information
Showing
44 changed files
with
1,391 additions
and
506 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,33 @@ | ||
| /* "emsig"-colours | ||
| blue : #447fc1 | ||
| blue-lighter : #61a2d8 | ||
| blue-darker : #285985 | ||
| red : #ef413d | ||
| */ | ||
|
|
||
| /* Button colours */ | ||
|
|
||
| .btn-info { | ||
| font-weight: bold; | ||
| background: #447fc1; | ||
| border-color: #447fc1; | ||
| } | ||
|
|
||
| .btn-info:hover { | ||
| background: #ef413d; | ||
| border-color: #ef413d; | ||
| } | ||
|
|
||
| /* Card headers */ | ||
| .card-header { | ||
| font-size: var(--pst-font-size-h5); | ||
| font-weight: bold; | ||
| padding: 1rem 2rem; | ||
| text-align: center; | ||
| } | ||
|
|
||
| /* fa stuff */ | ||
| .fa { | ||
| margin: 0 1rem 0 0; | ||
| color: #ef413d; | ||
| } |
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
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
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,28 +1,28 @@ | ||
| .. _dev-contributing: | ||
|
|
||
| Contributing | ||
| ============ | ||
|
|
||
| .. todo:: | ||
| emg3d is a community code, and contributions of any kind are welcomed: From | ||
| typos in the documentation to additional examples, reporting or fixing bugs in | ||
| the code, all the way to new suggestion or implementing new features. | ||
|
|
||
| Good places to get started is to browse the existing issues, check out the | ||
| roadmap, or have a look at any open PR: | ||
|
|
||
| Rework this for version 1. | ||
| - `Issues <https://github.com/emsig/emg3d/issues>`_; | ||
| - `Roadmap-project <https://github.com/emsig/emg3d/projects/1>`_; | ||
| - `PR's <https://github.com/emsig/emg3d/pulls>`_. | ||
|
|
||
| New contributions, bug reports, or any kind of feedback is always welcomed! | ||
| Have a look at the `Roadmap-project | ||
| <https://github.com/emsig/emg3d/projects/1>`_ to get an idea of things that | ||
| could be implemented. The GitHub `issues | ||
| <https://github.com/emsig/emg3d/issues>`_ and | ||
| `PR's <https://github.com/emsig/emg3d/pulls>`_ are also a good starting | ||
| point. The best way for interaction is at https://github.com/emsig or by | ||
| joining the `Slack channel <http://slack.simpeg.xyz>`_ «em-x-d» of SimPEG. If | ||
| you prefer to get in touch outside of GitHub/Slack use the contact form on | ||
| https://werthmuller.org. | ||
| There are various different ways to get in touch, see | ||
| `emsig.xyz#contributing-contact <https://emsig.xyz/#contributing-contact>`_. | ||
|
|
||
| To install emg3d from source, you can download the latest version from GitHub | ||
| and install it in your python distribution via: | ||
| If you think about making changes to the code and contribute code have a look | ||
| at :doc:`tests` | ||
|
|
||
| .. code-block:: console | ||
|
|
||
| make install | ||
| .. note:: | ||
|
|
||
| Please make sure your code follows the pep8-guidelines by using, for instance, | ||
| the python module ``flake8``, and also that your code is covered with | ||
| appropriate tests. Just get in touch if you have any doubts. | ||
| The community is tiny so far, so there are no former protocols (such as | ||
| CoC) in place (yet). Please get in touch if you think it is about time to | ||
| implement those. |
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
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
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,75 +1,77 @@ | ||
| Making a release | ||
| ================ | ||
|
|
||
| .. todo:: | ||
|
|
||
| Rework this for version 1. | ||
| Making a release is by now straight forward. Creating a «New Release» on GitHub | ||
| will trigger all the required things. However, there are still a few things to | ||
| do beforehand and a few things to check afterwards. | ||
|
|
||
| 1. Update ``CHANGELOG.rst``. | ||
|
|
||
| 2. Push it to GitHub, create a release tagging it. | ||
|
|
||
| 3. Tagging it on GitHub will automatically deploy it to PyPi, which in turn | ||
| will create a PR for the conda-forge `feedstock | ||
| <https://github.com/conda-forge/emg3d-feedstock>`_. Merge that PR. | ||
| <https://github.com/conda-forge/emg3d-feedstock>`_. The PR will be | ||
| automatically merged. (Note: if the dependencies change or the minimum | ||
| Python version or other installation things then the feedstock has to be | ||
| updated manually!) | ||
|
|
||
| 4. Check that: | ||
| 4. After releasing it, check that: | ||
|
|
||
| - `PyPi <https://pypi.org/project/emg3d>`_ deployed; | ||
| - `conda-forge <https://anaconda.org/conda-forge/emg3d>`_ deployed; | ||
| - `Zenodo <https://doi.org/10.5281/zenodo.3229006>`_ minted a DOI; | ||
| - `emg3d.emsig.xyz <https://emg3d.emsig.xyz>`_ created a tagged version. | ||
|
|
||
|
|
||
| Useful things | ||
| ------------- | ||
|
|
||
| - If there were changes to README, check it with:: | ||
|
|
||
| python setup.py --long-description | rst2html.py --no-raw > index.html | ||
|
|
||
| - If unsure, test it first on testpypi (requires ~/.pypirc):: | ||
|
|
||
| ~/anaconda3/bin/twine upload dist/* -r testpypi | ||
|
|
||
| - If unsure, test the test-pypi for conda if the skeleton builds:: | ||
|
|
||
| conda skeleton pypi --pypi-url https://test.pypi.io/pypi/ emg3d | ||
|
|
||
| - If it fails, you might have to install ``python3-setuptools``:: | ||
|
|
||
| sudo apt install python3-setuptools | ||
|
|
||
|
|
||
| CI | ||
| -- | ||
| CI automatic and manual bits | ||
| ---------------------------- | ||
|
|
||
| Automatic bits | ||
| `````````````` | ||
| Automatic | ||
| ````````` | ||
|
|
||
| - Testing on Github Actions includes: | ||
| - Testing on `Github Actions <https://github.com/emsig/emg3d/actions>`_ | ||
| includes: | ||
|
|
||
| - Tests using ``pytest`` | ||
| - Tests using ``pytest`` (Linux, MacOS, Windows) | ||
| - Linting / code style with ``pytest-flake8`` | ||
| - Ensure all http(s)-links work (``sphinx linkcheck``) | ||
| - Ensure all http(s)-links work (``sphinx -b linkcheck``) | ||
|
|
||
| - Line-coverage with ``pytest-cov`` on `Coveralls | ||
| <https://coveralls.io/github/emsig/emg3d>`_ | ||
| - Code-quality on `Codacy | ||
| <https://app.codacy.com/manual/prisae/emg3d/dashboard>`_ | ||
| <https://app.codacy.com/gh/emsig/emg3d/dashboard>`_ | ||
| - Manual on `ReadTheDocs <https://emg3d.emsig.xyz/en/latest>`_ | ||
| - DOI minting on `Zenodo <https://doi.org/10.5281/zenodo.3229006>`_ | ||
|
|
||
| Manual things | ||
| ````````````` | ||
| Manual | ||
| `````` | ||
|
|
||
| - Benchmarks with `Airspeed Velocity <https://emsig.xyz/emg3d-asv>`_ | ||
| (``asv``) | ||
| - Gallery in `emg3d-gallery <https://emsig.xyz/emg3d-gallery>`_ | ||
| (``sphinx-gallery``) | ||
|
|
||
| Automatically deploys if tagged | ||
| ``````````````````````````````` | ||
|
|
||
| - `PyPi <https://pypi.org/project/emg3d>`_ | ||
| - `conda -c conda-forge <https://anaconda.org/conda-forge/emg3d>`_ | ||
| Useful things | ||
| ------------- | ||
|
|
||
| The following info was from the time when we still manually deployed. Now | ||
| every push to main triggers a test to Test-PyPI, so things can be verified | ||
| there. However, these hints my still be useful at some point. | ||
|
|
||
| - If there were changes to README, check it with:: | ||
|
|
||
| python setup.py --long-description | rst2html.py --no-raw > index.html | ||
|
|
||
| - If unsure about something, test it first on testpypi (requires ~/.pypirc):: | ||
|
|
||
| ~/anaconda3/bin/twine upload dist/* -r testpypi | ||
|
|
||
| - If unsure, test the test-pypi for conda if the skeleton builds:: | ||
|
|
||
| conda skeleton pypi --pypi-url https://test.pypi.io/pypi/ emg3d | ||
|
|
||
| - If it fails, you might have to install ``python3-setuptools``:: | ||
|
|
||
| sudo apt install python3-setuptools |
Oops, something went wrong.