Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
tukiains committed Nov 20, 2022
1 parent 1ddd4f8 commit 458623d
Show file tree
Hide file tree
Showing 4 changed files with 9 additions and 6 deletions.
3 changes: 1 addition & 2 deletions .github/workflows/test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,7 @@ jobs:
mypy --ignore-missing-imports tests/
- name: Test with pytest-flakefinder
run: |
pytest --flake-finder tests/unit/ --flake-runs=2
pytest --flake-finder cloudnetpy/model_evaluation/tests/unit/ --flake-runs=2
pytest --flake-finder --flake-runs=2
- name: Run e2e-test
run: |
python3 tests/e2e_test.py
Expand Down
9 changes: 6 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,23 +47,26 @@ We encourage you to contribute to CloudnetPy! Please check out the [contribution

## Development

Follow the installation instructions from the source above but instead of `pip install .` install with the test-dependencies and [pre-commit](https://pre-commit.com/) hooks:
Follow the installation instructions from the source above but install with the test-dependencies and [pre-commit](https://pre-commit.com/) hooks:
```sh
python3 -m pip install -e .[test,dev]
pre-commit install
```

Run unit tests:
```sh
pytest
pytest --flake-finder --flake-runs=2
```

Run end-to-end tests:
```sh
python3 tests/e2e_test.py
```
```sh
for f in cloudnetpy/model_evaluation/tests/e2e/*/main.py; do $f; done
```

Force `pre-commit` checks of all files:
Force `pre-commit` checks (`pylint`, `mypy`, etc.) for all files:
```sh
pre-commit run --all
```
Expand Down
1 change: 0 additions & 1 deletion cloudnetpy/products/drizzle.py
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,6 @@ def _calc_lwc(self):
"""Calculates drizzle liquid water content (kg m-3)"""
rho_water = 1000
dia, mu, s = [self._params.get(key) for key in ("Do", "mu", "S")]
print(dia, mu, s)
assert isinstance(mu, np.ndarray)
assert isinstance(s, np.ndarray)
assert isinstance(dia, np.ndarray)
Expand Down
2 changes: 2 additions & 0 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,8 @@
classifiers=[
"Development Status :: 5 - Production/Stable",
"Programming Language :: Python :: 3.8",
"Programming Language :: Python :: 3.9",
"Programming Language :: Python :: 3.10",
"License :: OSI Approved :: MIT License",
"Operating System :: OS Independent",
"Intended Audience :: Science/Research",
Expand Down

0 comments on commit 458623d

Please sign in to comment.