Skip to content

Commit

Permalink
Some fixes to address improvements suggested during JOSS review
Browse files Browse the repository at this point in the history
- Warning note on git lfs added to CONTRIBUTING.md (fixes #14)
- List of main dependencies added to README (fixes #15)
- Document how to run unit/integration tests in CONTRIBUTING (fixes #13)
  • Loading branch information
loicdtx committed Jul 10, 2024
1 parent 8adf420 commit fc6448a
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 0 deletions.
10 changes: 10 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,18 @@ For any contribution to the code base or the documentation, use the pull request
2. Apply changes to your fork.
3. Open a pull request on github


Your contribution will be reviewed and discussied as part of the pull request. If approved, it will then be merged
into the main branch of the repository and included in the following release.

> :warning: **Ensure that you have git-lfs installed**: The test data included in the package (reasonably sized netCDF and GeoTIFF files) are versioned using Git with the Large File Storage (LFS) extension. Cloning the repository without LFS installed will silently replace these files with placeholders, causing some tests to fail.
### Testing

We use `pytest` for unit tests.

- Unit tests are written using the `pytest` framework.
- Tests are automatically run using GitHub CI with every push and pull request.
- You can run tests locally by simply calling `pytest` in the root directory of the project.


16 changes: 16 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,16 @@ Installation
pip install nrt
The main dependencies, which should be automatically resolved by ``pip``, are:

- `numpy <https://pypi.org/project/numpy/>`_
- `scipy <https://pypi.org/project/scipy/>`_
- `xarray <https://pypi.org/project/xarray/>`_
- `numba <https://pypi.org/project/numba/>`_
- `rasterio <https://pypi.org/project/rasterio/>`_
- `netCDF4 <https://pypi.org/project/netCDF4/>`_


Example usage
=============

Expand Down Expand Up @@ -97,6 +107,12 @@ The snippet below presents a near real time monitoring simulation. The input dat
# EwmaMonitor.to_netcdf(filename)
Contributing
============

Any type of contribution is welcome. Please see the contributing guidelines at `CONTRIBUTING.md <CONTRIBUTING.md>`_.


About the authors
=================

Expand Down

0 comments on commit fc6448a

Please sign in to comment.