From 51546c186276f71a400043fe3e90fc24a032aef0 Mon Sep 17 00:00:00 2001 From: Dobson Date: Thu, 21 Mar 2024 11:19:00 +0000 Subject: [PATCH 01/17] Create LICENSE --- LICENSE | 29 +++++++++++++++++++++++++++++ 1 file changed, 29 insertions(+) create mode 100644 LICENSE diff --git a/LICENSE b/LICENSE new file mode 100644 index 00000000..c7ea631c --- /dev/null +++ b/LICENSE @@ -0,0 +1,29 @@ +BSD 3-Clause License + +Copyright (c) 2022, barneydobson +All rights reserved. + +Redistribution and use in source and binary forms, with or without +modification, are permitted provided that the following conditions are met: + +1. Redistributions of source code must retain the above copyright notice, this + list of conditions and the following disclaimer. + +2. Redistributions in binary form must reproduce the above copyright notice, + this list of conditions and the following disclaimer in the documentation + and/or other materials provided with the distribution. + +3. Neither the name of the copyright holder nor the names of its + contributors may be used to endorse or promote products derived from + this software without specific prior written permission. + +THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" +AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE +DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE +FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR +SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER +CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, +OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE +OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. From e05784c6f6097aa15553e13954b05bec961d101d Mon Sep 17 00:00:00 2001 From: Dobson Date: Thu, 21 Mar 2024 11:25:22 +0000 Subject: [PATCH 02/17] add from wsimod --- site/CODE_OF_CONDUCT/index.html | 595 ++++++++++++++++++++++++++++++++ site/CONTRIBUTING/index.html | 490 ++++++++++++++++++++++++++ 2 files changed, 1085 insertions(+) create mode 100644 site/CODE_OF_CONDUCT/index.html create mode 100644 site/CONTRIBUTING/index.html diff --git a/site/CODE_OF_CONDUCT/index.html b/site/CODE_OF_CONDUCT/index.html new file mode 100644 index 00000000..e4874c40 --- /dev/null +++ b/site/CODE_OF_CONDUCT/index.html @@ -0,0 +1,595 @@ + + + + + + + + + + + + + + + + Contributor Covenant Code of Conduct - WSIMOD docs + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + Skip to content + + +
+
+ +
+ + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + +

Contributor Covenant Code of Conduct

+

Our Pledge

+

We as members, contributors, and leaders pledge to make participation in our +community a harassment-free experience for everyone, regardless of age, body +size, visible or invisible disability, ethnicity, sex characteristics, gender +identity and expression, level of experience, education, socio-economic status, +nationality, personal appearance, race, caste, color, religion, or sexual +identity and orientation.

+

We pledge to act and interact in ways that contribute to an open, welcoming, +diverse, inclusive, and healthy community.

+

Our Standards

+

Examples of behavior that contributes to a positive environment for our +community include:

+
    +
  • Demonstrating empathy and kindness toward other people
    • +
  • Being respectful of differing opinions, viewpoints, and experiences
    • +
  • Giving and gracefully accepting constructive feedback
    • +
  • Accepting responsibility and apologizing to those affected by our mistakes, + and learning from the experience
    • +
  • Focusing on what is best not just for us as individuals, but for the overall + community
    • +
+

Examples of unacceptable behavior include:

+
    +
  • The use of sexualized language or imagery, and sexual attention or advances of + any kind
    • +
  • Trolling, insulting or derogatory comments, and personal or political attacks
    • +
  • Public or private harassment
    • +
  • Publishing others' private information, such as a physical or email address, + without their explicit permission
    • +
  • Other conduct which could reasonably be considered inappropriate in a + professional setting
    • +
+

Enforcement Responsibilities

+

Community leaders are responsible for clarifying and enforcing our standards of +acceptable behavior and will take appropriate and fair corrective action in +response to any behavior that they deem inappropriate, threatening, offensive, +or harmful.

+

Community leaders have the right and responsibility to remove, edit, or reject +comments, commits, code, wiki edits, issues, and other contributions that are +not aligned to this Code of Conduct, and will communicate reasons for moderation +decisions when appropriate.

+

Scope

+

This Code of Conduct applies within all community spaces, and also applies when +an individual is officially representing the community in public spaces. +Examples of representing our community include using an official e-mail address, +posting via an official social media account, or acting as an appointed +representative at an online or offline event.

+

Enforcement

+

Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported to the community leaders responsible for enforcement at +[INSERT CONTACT METHOD]. +All complaints will be reviewed and investigated promptly and fairly.

+

All community leaders are obligated to respect the privacy and security of the +reporter of any incident.

+

Enforcement Guidelines

+

Community leaders will follow these Community Impact Guidelines in determining +the consequences for any action they deem in violation of this Code of Conduct:

+

1. Correction

+

Community Impact: Use of inappropriate language or other behavior deemed +unprofessional or unwelcome in the community.

+

Consequence: A private, written warning from community leaders, providing +clarity around the nature of the violation and an explanation of why the +behavior was inappropriate. A public apology may be requested.

+

2. Warning

+

Community Impact: A violation through a single incident or series of +actions.

+

Consequence: A warning with consequences for continued behavior. No +interaction with the people involved, including unsolicited interaction with +those enforcing the Code of Conduct, for a specified period of time. This +includes avoiding interactions in community spaces as well as external channels +like social media. Violating these terms may lead to a temporary or permanent +ban.

+

3. Temporary Ban

+

Community Impact: A serious violation of community standards, including +sustained inappropriate behavior.

+

Consequence: A temporary ban from any sort of interaction or public +communication with the community for a specified period of time. No public or +private interaction with the people involved, including unsolicited interaction +with those enforcing the Code of Conduct, is allowed during this period. +Violating these terms may lead to a permanent ban.

+

4. Permanent Ban

+

Community Impact: Demonstrating a pattern of violation of community +standards, including sustained inappropriate behavior, harassment of an +individual, or aggression toward or disparagement of classes of individuals.

+

Consequence: A permanent ban from any sort of public interaction within the +community.

+

Attribution

+

This Code of Conduct is adapted from the Contributor Covenant, +version 2.1, available at +https://www.contributor-covenant.org/version/2/1/code_of_conduct.html.

+

Community Impact Guidelines were inspired by +Mozilla's code of conduct enforcement ladder.

+

For answers to common questions about this code of conduct, see the FAQ at +https://www.contributor-covenant.org/faq. Translations are available at +https://www.contributor-covenant.org/translations.

+ + + + + + +
+
+ + +
+ +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/site/CONTRIBUTING/index.html b/site/CONTRIBUTING/index.html new file mode 100644 index 00000000..9eb9239c --- /dev/null +++ b/site/CONTRIBUTING/index.html @@ -0,0 +1,490 @@ + + + + + + + + + + + + + + + + Contributing to `WSIMOD` - WSIMOD docs + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + Skip to content + + +
+
+ +
+ + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + +

Contributing to WSIMOD

+

Thank you for considering contributing to WSIMOD.

+

Bugs

+

Please create a new issues if you may have found a bug. Please describe the bug and instructions on recreating it (including OS and Python version). It may be helpful to use examples from the tutorials or how-to's to ensure that data is available.

+

Confusion

+

If you are confused about how a model component works, or why it is producing results that look the way they do, please first check the documentation and existing issues. If this does not answer your question, or your question has not yet been raised, then please create a new issue where we can discuss it.

+

Creating new functionality

+

Is there something in the water cycle that you would like to represent that is not included in WSIMOD? Whatever it is, you are probably not alone! If there is not one already, please create an issue where we can discuss it. Do this before you start developing as others may be working on the same thing!

+

Although the development of new functionality will depend highly on the case, there are a few generalisable points to bear in mind: + - WSIMOD is highly object-oriented, thus, we will always try to implement a new component as a subclass of the closest component. We will collaboratively discuss this in the issue. + - Our documentation relies heavily on use of docstrings, make sure to format it following the Google Python style, see the source code of Land.__init__ for an example. An admin will compile the documentation, but you can create your own pages to be added by following the directions below. + - We are incredibly grateful for contributions that include new tutorials or how-to's, whether for new or existing functionality. Our use of the mkdocs-jupyter extension enables notebooks to form pages in the documentation, but that can also serve as downloadable examples that people can run. + - Design new tests that instantiate your new functionality and test that it produces a specified response. New tests are stored in the wsi/tests/ folder. You can run tests by navigating to the folder and running: + pytest # run all tests + pytest tests/test_file.py # run a specific file's tests

+
You can check the coverage for these tests by running:
+```
+coverage run -m pytest
+coverage report
+```
+
+And generate a new coverage html for the documentation with
+```
+coverage html
+```
+
+

Create documentation

+

If you want to compile new documentation you will need to clone the reposistory and pip install WSIMOD with some additional packages:

+
pip install .[documentation]
+
+

Navigate to docs and run the following to create the component library:

+
python create_class_page.py
+
+

And then open python, and run:

+
import pypandoc
+pypandoc.download_pandoc()
+
+

From here, you can make changes to the documentation pages in docs and view how they appear by navigating to and hosting them locally:

+
mkdocs serve
+
+

If compiling documentation, you will need to install git:

+
conda install git
+
+

And deploy:

+
mkdocs gh-deploy
+
+ + + + + + +
+
+ + +
+ +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file From f250841c34ae5e0060721ab56eeaea9ae304b7b9 Mon Sep 17 00:00:00 2001 From: Dobson Date: Thu, 21 Mar 2024 11:27:42 +0000 Subject: [PATCH 03/17] move to readme --- CODE_OF_CONDUCT.md | 133 +++++++ CONTRIBUTING.md | 110 ++++++ site/CODE_OF_CONDUCT/index.html | 595 -------------------------------- site/CONTRIBUTING/index.html | 490 -------------------------- 4 files changed, 243 insertions(+), 1085 deletions(-) create mode 100644 CODE_OF_CONDUCT.md create mode 100644 CONTRIBUTING.md delete mode 100644 site/CODE_OF_CONDUCT/index.html delete mode 100644 site/CONTRIBUTING/index.html diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 00000000..45d257b2 --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,133 @@ + +# Contributor Covenant Code of Conduct + +## Our Pledge + +We as members, contributors, and leaders pledge to make participation in our +community a harassment-free experience for everyone, regardless of age, body +size, visible or invisible disability, ethnicity, sex characteristics, gender +identity and expression, level of experience, education, socio-economic status, +nationality, personal appearance, race, caste, color, religion, or sexual +identity and orientation. + +We pledge to act and interact in ways that contribute to an open, welcoming, +diverse, inclusive, and healthy community. + +## Our Standards + +Examples of behavior that contributes to a positive environment for our +community include: + +* Demonstrating empathy and kindness toward other people +* Being respectful of differing opinions, viewpoints, and experiences +* Giving and gracefully accepting constructive feedback +* Accepting responsibility and apologizing to those affected by our mistakes, + and learning from the experience +* Focusing on what is best not just for us as individuals, but for the overall + community + +Examples of unacceptable behavior include: + +* The use of sexualized language or imagery, and sexual attention or advances of + any kind +* Trolling, insulting or derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information, such as a physical or email address, + without their explicit permission +* Other conduct which could reasonably be considered inappropriate in a + professional setting + +## Enforcement Responsibilities + +Community leaders are responsible for clarifying and enforcing our standards of +acceptable behavior and will take appropriate and fair corrective action in +response to any behavior that they deem inappropriate, threatening, offensive, +or harmful. + +Community leaders have the right and responsibility to remove, edit, or reject +comments, commits, code, wiki edits, issues, and other contributions that are +not aligned to this Code of Conduct, and will communicate reasons for moderation +decisions when appropriate. + +## Scope + +This Code of Conduct applies within all community spaces, and also applies when +an individual is officially representing the community in public spaces. +Examples of representing our community include using an official e-mail address, +posting via an official social media account, or acting as an appointed +representative at an online or offline event. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported to the community leaders responsible for enforcement at +[INSERT CONTACT METHOD]. +All complaints will be reviewed and investigated promptly and fairly. + +All community leaders are obligated to respect the privacy and security of the +reporter of any incident. + +## Enforcement Guidelines + +Community leaders will follow these Community Impact Guidelines in determining +the consequences for any action they deem in violation of this Code of Conduct: + +### 1. Correction + +**Community Impact**: Use of inappropriate language or other behavior deemed +unprofessional or unwelcome in the community. + +**Consequence**: A private, written warning from community leaders, providing +clarity around the nature of the violation and an explanation of why the +behavior was inappropriate. A public apology may be requested. + +### 2. Warning + +**Community Impact**: A violation through a single incident or series of +actions. + +**Consequence**: A warning with consequences for continued behavior. No +interaction with the people involved, including unsolicited interaction with +those enforcing the Code of Conduct, for a specified period of time. This +includes avoiding interactions in community spaces as well as external channels +like social media. Violating these terms may lead to a temporary or permanent +ban. + +### 3. Temporary Ban + +**Community Impact**: A serious violation of community standards, including +sustained inappropriate behavior. + +**Consequence**: A temporary ban from any sort of interaction or public +communication with the community for a specified period of time. No public or +private interaction with the people involved, including unsolicited interaction +with those enforcing the Code of Conduct, is allowed during this period. +Violating these terms may lead to a permanent ban. + +### 4. Permanent Ban + +**Community Impact**: Demonstrating a pattern of violation of community +standards, including sustained inappropriate behavior, harassment of an +individual, or aggression toward or disparagement of classes of individuals. + +**Consequence**: A permanent ban from any sort of public interaction within the +community. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], +version 2.1, available at +[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1]. + +Community Impact Guidelines were inspired by +[Mozilla's code of conduct enforcement ladder][Mozilla CoC]. + +For answers to common questions about this code of conduct, see the FAQ at +[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at +[https://www.contributor-covenant.org/translations][translations]. + +[homepage]: https://www.contributor-covenant.org +[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html +[Mozilla CoC]: https://github.com/mozilla/diversity +[FAQ]: https://www.contributor-covenant.org/faq +[translations]: https://www.contributor-covenant.org/translations diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..89466e36 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,110 @@ +# Contributing to `WSIMOD` + +Thank you for considering contributing to `WSIMOD`. + +## Bugs + +Please create a new [issues](https://github.com/ImperialCollegeLondon/wsi/issues) if you may have found a bug. Please describe the bug and instructions on recreating it (including OS and Python version). It may be helpful to use examples from the [tutorials](https://imperialcollegelondon.github.io/wsi/tutorials/) or [how-to's](https://imperialcollegelondon.github.io/wsi/how-to/) to ensure that data is available. + +## Confusion + +If you are confused about how a model component works, or why it is producing results that look the way they do, please first check the [documentation](https://imperialcollegelondon.github.io/wsi/) and existing [issues](https://imperialcollegelondon.github.io/wsi/issues). If this does not answer your question, or your question has not yet been raised, then please create a new issue where we can discuss it. + +## Creating new functionality + +Is there something in the water cycle that you would like to represent that is not included in `WSIMOD`? Whatever it is, you are probably not alone! If there is not one already, please create an [issue](https://imperialcollegelondon.github.io/wsi/issues) where we can discuss it. Do this _before_ you start developing as others may be working on the same thing! + +Although the development of new functionality will depend highly on the case, there are a few generalisable points to bear in mind: + +- `WSIMOD` is highly object-oriented, thus, we will always try to implement a new component as a subclass of the closest component. We will collaboratively discuss this in the issue. +- Our [documentation](https://imperialcollegelondon.github.io/wsi) relies heavily on use of docstrings, make sure to format it following the [Google Python style](https://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_google.html), see the source code of [`Land.__init__`](https://imperialcollegelondon.github.io/wsi/reference-land/#wsimod.nodes.land.Land.__init__) for an example. An admin will compile the documentation, but you can create your own pages to be added by following the directions [below](#create-documentation). +- We are incredibly grateful for contributions that include new [tutorials](https://imperialcollegelondon.github.io/wsi/tutorials/) or [how-to's](https://imperialcollegelondon.github.io/wsi/how-to/), whether for new or existing functionality. Our use of the [mkdocs-jupyter](https://github.com/danielfrg/mkdocs-jupyter) extension enables notebooks to form pages in the documentation, but that can also serve as downloadable examples that people can run. +- Design new tests that instantiate your new functionality and test that it produces a specified response. New tests are stored in the `wsi/tests/` folder. + +## Installation for development + +To install WSIMOD in development mode, first you will need a virtual environment. Here we use a `conda` environment which let us use the version of python we want to use, +but you can use any other tool you are familiar with. Just make sure you use a version of Python compatible with WSIMOD. + +```bash +conda create --name wsimod python=3.10 +conda activate wsimod +``` + +Once in the environment, you need to clone the WSIMOD GitHub repository locally and move into the right folder. You will need `git` for that, installed either following the [official instructions](https://git-scm.com/downloads) or with `conda install git`, if you use `conda`. + +```bash +git clone https://github.com/ImperialCollegeLondon/wsi.git +cd wsi +``` + +We use [`pip-tools`](https://pip-tools.readthedocs.io/en/latest/) to ensure consistency in the development process, ensuring all people contributing to WSIMOD uses the same versions for all the dependencies, which minimiese the conflicts. To install the development dependencies and then WISMO in development mode run: + +```bash +pip install -r requirements-dev.txt +pip install -e . +``` + +You can also install the dependencies required to run the demos and tutorials with: + +```bash +pip install -r requirements-demos.txt +``` + +## Quality assurance and linting + +WSIMOD uses a collection of tools that ensure that a specific code style and formatting is follow throughout the software. The tools we used for that are [`ruff`](https://docs.astral.sh/ruff/) and [`markdownlint`](https://github.com/igorshubovych/markdownlint-cli). You do not need to run them manually - unless you want to - but rather they are run automatically every time you make a commit thanks to `pre-commit`. + +`pre-commit` should already have been installed when installing the `dev` dependencies, if you followed the instructions above, but you need to activate the hooks that `git` will run when making a commit. To do that just run: + +```bash +pre-commit install +``` + +You can customise the checks that `ruff` will make with the settings in `pyproject.toml`. For `markdownlint`, you need to oedit the arguments included in the .`pre-commit-config.yaml` file. + +## Testing and coverage + +WSIMOD uses `pytests` as testing suite. You can run tests by navigating to the folder and running: + +```bash +pytest # run all tests +pytest tests/test_file.py # run a specific file's tests +``` + +You can check the coverage for these tests by running: + +```bash +coverage run -m pytest +coverage report +``` + +And generate a new coverage html for the documentation with + +```bash +coverage html +``` + +## Create documentation + +If you want to compile new documentation you will need some additional packages, installed with: + +```bash +pip install -r requirements-doc.txt +``` + +From here, you can make changes to the documentation pages in `docs` and view how they appear by navigating to and hosting them locally: + +```bash +mkdocs serve +``` + +If compiling and deploying documentation, you will need to have `git` installed (see above). Then: + +```bash +mkdocs gh-deploy +``` + +## Changing dependencies + +Is as the development process moves forward you find you need to add a new dependency, just add it to the relevant section of the `pyproject.toml` file and then run `pip-compile` as required to regenerate the different `requirements.txt` files. Read the [`pip-tools` documentation](https://pip-tools.readthedocs.io/en/latest/) for more information on the process. diff --git a/site/CODE_OF_CONDUCT/index.html b/site/CODE_OF_CONDUCT/index.html deleted file mode 100644 index e4874c40..00000000 --- a/site/CODE_OF_CONDUCT/index.html +++ /dev/null @@ -1,595 +0,0 @@ - - - - - - - - - - - - - - - - Contributor Covenant Code of Conduct - WSIMOD docs - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - Skip to content - - -
-
- -
- - - - -
- - -
- -
- - - - - - -
-
- - - -
-
-
- - - - -
-
-
- - - -
-
-
- - - -
-
-
- - - -
-
- - - - -

Contributor Covenant Code of Conduct

-

Our Pledge

-

We as members, contributors, and leaders pledge to make participation in our -community a harassment-free experience for everyone, regardless of age, body -size, visible or invisible disability, ethnicity, sex characteristics, gender -identity and expression, level of experience, education, socio-economic status, -nationality, personal appearance, race, caste, color, religion, or sexual -identity and orientation.

-

We pledge to act and interact in ways that contribute to an open, welcoming, -diverse, inclusive, and healthy community.

-

Our Standards

-

Examples of behavior that contributes to a positive environment for our -community include:

-
    -
  • Demonstrating empathy and kindness toward other people
    • -
  • Being respectful of differing opinions, viewpoints, and experiences
    • -
  • Giving and gracefully accepting constructive feedback
    • -
  • Accepting responsibility and apologizing to those affected by our mistakes, - and learning from the experience
    • -
  • Focusing on what is best not just for us as individuals, but for the overall - community
    • -
-

Examples of unacceptable behavior include:

-
    -
  • The use of sexualized language or imagery, and sexual attention or advances of - any kind
    • -
  • Trolling, insulting or derogatory comments, and personal or political attacks
    • -
  • Public or private harassment
    • -
  • Publishing others' private information, such as a physical or email address, - without their explicit permission
    • -
  • Other conduct which could reasonably be considered inappropriate in a - professional setting
    • -
-

Enforcement Responsibilities

-

Community leaders are responsible for clarifying and enforcing our standards of -acceptable behavior and will take appropriate and fair corrective action in -response to any behavior that they deem inappropriate, threatening, offensive, -or harmful.

-

Community leaders have the right and responsibility to remove, edit, or reject -comments, commits, code, wiki edits, issues, and other contributions that are -not aligned to this Code of Conduct, and will communicate reasons for moderation -decisions when appropriate.

-

Scope

-

This Code of Conduct applies within all community spaces, and also applies when -an individual is officially representing the community in public spaces. -Examples of representing our community include using an official e-mail address, -posting via an official social media account, or acting as an appointed -representative at an online or offline event.

-

Enforcement

-

Instances of abusive, harassing, or otherwise unacceptable behavior may be -reported to the community leaders responsible for enforcement at -[INSERT CONTACT METHOD]. -All complaints will be reviewed and investigated promptly and fairly.

-

All community leaders are obligated to respect the privacy and security of the -reporter of any incident.

-

Enforcement Guidelines

-

Community leaders will follow these Community Impact Guidelines in determining -the consequences for any action they deem in violation of this Code of Conduct:

-

1. Correction

-

Community Impact: Use of inappropriate language or other behavior deemed -unprofessional or unwelcome in the community.

-

Consequence: A private, written warning from community leaders, providing -clarity around the nature of the violation and an explanation of why the -behavior was inappropriate. A public apology may be requested.

-

2. Warning

-

Community Impact: A violation through a single incident or series of -actions.

-

Consequence: A warning with consequences for continued behavior. No -interaction with the people involved, including unsolicited interaction with -those enforcing the Code of Conduct, for a specified period of time. This -includes avoiding interactions in community spaces as well as external channels -like social media. Violating these terms may lead to a temporary or permanent -ban.

-

3. Temporary Ban

-

Community Impact: A serious violation of community standards, including -sustained inappropriate behavior.

-

Consequence: A temporary ban from any sort of interaction or public -communication with the community for a specified period of time. No public or -private interaction with the people involved, including unsolicited interaction -with those enforcing the Code of Conduct, is allowed during this period. -Violating these terms may lead to a permanent ban.

-

4. Permanent Ban

-

Community Impact: Demonstrating a pattern of violation of community -standards, including sustained inappropriate behavior, harassment of an -individual, or aggression toward or disparagement of classes of individuals.

-

Consequence: A permanent ban from any sort of public interaction within the -community.

-

Attribution

-

This Code of Conduct is adapted from the Contributor Covenant, -version 2.1, available at -https://www.contributor-covenant.org/version/2/1/code_of_conduct.html.

-

Community Impact Guidelines were inspired by -Mozilla's code of conduct enforcement ladder.

-

For answers to common questions about this code of conduct, see the FAQ at -https://www.contributor-covenant.org/faq. Translations are available at -https://www.contributor-covenant.org/translations.

- - - - - - -
-
- - -
- -
- - - -
-
-
-
- - - - - - - - - - \ No newline at end of file diff --git a/site/CONTRIBUTING/index.html b/site/CONTRIBUTING/index.html deleted file mode 100644 index 9eb9239c..00000000 --- a/site/CONTRIBUTING/index.html +++ /dev/null @@ -1,490 +0,0 @@ - - - - - - - - - - - - - - - - Contributing to `WSIMOD` - WSIMOD docs - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - Skip to content - - -
-
- -
- - - - -
- - -
- -
- - - - - - -
-
- - - -
-
-
- - - - -
-
-
- - - -
-
-
- - - -
-
-
- - - -
-
- - - - -

Contributing to WSIMOD

-

Thank you for considering contributing to WSIMOD.

-

Bugs

-

Please create a new issues if you may have found a bug. Please describe the bug and instructions on recreating it (including OS and Python version). It may be helpful to use examples from the tutorials or how-to's to ensure that data is available.

-

Confusion

-

If you are confused about how a model component works, or why it is producing results that look the way they do, please first check the documentation and existing issues. If this does not answer your question, or your question has not yet been raised, then please create a new issue where we can discuss it.

-

Creating new functionality

-

Is there something in the water cycle that you would like to represent that is not included in WSIMOD? Whatever it is, you are probably not alone! If there is not one already, please create an issue where we can discuss it. Do this before you start developing as others may be working on the same thing!

-

Although the development of new functionality will depend highly on the case, there are a few generalisable points to bear in mind: - - WSIMOD is highly object-oriented, thus, we will always try to implement a new component as a subclass of the closest component. We will collaboratively discuss this in the issue. - - Our documentation relies heavily on use of docstrings, make sure to format it following the Google Python style, see the source code of Land.__init__ for an example. An admin will compile the documentation, but you can create your own pages to be added by following the directions below. - - We are incredibly grateful for contributions that include new tutorials or how-to's, whether for new or existing functionality. Our use of the mkdocs-jupyter extension enables notebooks to form pages in the documentation, but that can also serve as downloadable examples that people can run. - - Design new tests that instantiate your new functionality and test that it produces a specified response. New tests are stored in the wsi/tests/ folder. You can run tests by navigating to the folder and running: - pytest # run all tests - pytest tests/test_file.py # run a specific file's tests

-
You can check the coverage for these tests by running:
-```
-coverage run -m pytest
-coverage report
-```
-
-And generate a new coverage html for the documentation with
-```
-coverage html
-```
-
-

Create documentation

-

If you want to compile new documentation you will need to clone the reposistory and pip install WSIMOD with some additional packages:

-
pip install .[documentation]
-
-

Navigate to docs and run the following to create the component library:

-
python create_class_page.py
-
-

And then open python, and run:

-
import pypandoc
-pypandoc.download_pandoc()
-
-

From here, you can make changes to the documentation pages in docs and view how they appear by navigating to and hosting them locally:

-
mkdocs serve
-
-

If compiling documentation, you will need to install git:

-
conda install git
-
-

And deploy:

-
mkdocs gh-deploy
-
- - - - - - -
-
- - -
- -
- - - -
-
-
-
- - - - - - - - - - \ No newline at end of file From 9ebde64d9670ce10ed1c6ab45a59eec4c2b8f1bb Mon Sep 17 00:00:00 2001 From: barneydobson Date: Thu, 21 Mar 2024 11:28:47 +0000 Subject: [PATCH 04/17] Update CODE_OF_CONDUCT.md --- CODE_OF_CONDUCT.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md index 45d257b2..f1386a79 100644 --- a/CODE_OF_CONDUCT.md +++ b/CODE_OF_CONDUCT.md @@ -61,7 +61,7 @@ representative at an online or offline event. Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at -[INSERT CONTACT METHOD]. +`b.dobson -at- imperial.ac.ak`. All complaints will be reviewed and investigated promptly and fairly. All community leaders are obligated to respect the privacy and security of the From 99943549f9b58e102810f29b4fc0cb976d5be602 Mon Sep 17 00:00:00 2001 From: Dobson Date: Thu, 21 Mar 2024 11:31:45 +0000 Subject: [PATCH 05/17] Create AUTHORS.md --- AUTHORS.md | 5 +++++ 1 file changed, 5 insertions(+) create mode 100644 AUTHORS.md diff --git a/AUTHORS.md b/AUTHORS.md new file mode 100644 index 00000000..e9412873 --- /dev/null +++ b/AUTHORS.md @@ -0,0 +1,5 @@ +# Developers + +* Barnaby Dobson +* Taher Chegini +* Diego Alonso Alvarez From f7b1a2c4902505f7f5d4a29657c36b681f425aa3 Mon Sep 17 00:00:00 2001 From: barneydobson Date: Thu, 21 Mar 2024 11:32:50 +0000 Subject: [PATCH 06/17] Update AUTHORS.md --- AUTHORS.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/AUTHORS.md b/AUTHORS.md index e9412873..73a802ed 100644 --- a/AUTHORS.md +++ b/AUTHORS.md @@ -1,5 +1,5 @@ # Developers -* Barnaby Dobson +* Barnaby Dobson `b.dobson - at - imperial.ac.uk` * Taher Chegini * Diego Alonso Alvarez From a0b69fff7f1498005221e86996b7fb6a339e6042 Mon Sep 17 00:00:00 2001 From: Dobson Date: Thu, 21 Mar 2024 11:36:59 +0000 Subject: [PATCH 07/17] Update CONTRIBUTING.md test new lines --- CONTRIBUTING.md | 16 +++++++++------- 1 file changed, 9 insertions(+), 7 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 89466e36..e55c53bc 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,16 +1,18 @@ -# Contributing to `WSIMOD` +# Contributing to `SWMManywhere` -Thank you for considering contributing to `WSIMOD`. +Thank you for considering contributing to `SWMManywhere`. ## Bugs -Please create a new [issues](https://github.com/ImperialCollegeLondon/wsi/issues) if you may have found a bug. Please describe the bug and instructions on recreating it (including OS and Python version). It may be helpful to use examples from the [tutorials](https://imperialcollegelondon.github.io/wsi/tutorials/) or [how-to's](https://imperialcollegelondon.github.io/wsi/how-to/) to ensure that data is available. +Please create a new [issues](https://github.com/ImperialCollegeLondon/SWMManywhere/issues) +if you may have found a bug. +Please describe the bug and instructions on recreating it (including OS and +Python version). -## Confusion +## Adding new `metrics` or `graphfcns` -If you are confused about how a model component works, or why it is producing results that look the way they do, please first check the [documentation](https://imperialcollegelondon.github.io/wsi/) and existing [issues](https://imperialcollegelondon.github.io/wsi/issues). If this does not answer your question, or your question has not yet been raised, then please create a new issue where we can discuss it. - -## Creating new functionality +Our intention with `SWMManywhere` is that a high level of customisation to suit +your needs Is there something in the water cycle that you would like to represent that is not included in `WSIMOD`? Whatever it is, you are probably not alone! If there is not one already, please create an [issue](https://imperialcollegelondon.github.io/wsi/issues) where we can discuss it. Do this _before_ you start developing as others may be working on the same thing! From adb6a0575877c5e52cd41b22d3c9ca36b7cfe9a1 Mon Sep 17 00:00:00 2001 From: Dobson Date: Thu, 21 Mar 2024 12:02:07 +0000 Subject: [PATCH 08/17] Update CONTRIBUTING.md --- CONTRIBUTING.md | 110 +++++++++++++++++++++++++++--------------------- 1 file changed, 62 insertions(+), 48 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index e55c53bc..90cd6504 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -7,67 +7,96 @@ Thank you for considering contributing to `SWMManywhere`. Please create a new [issues](https://github.com/ImperialCollegeLondon/SWMManywhere/issues) if you may have found a bug. Please describe the bug and instructions on recreating it (including OS and -Python version). +Python version). Label the issue with `bug`. -## Adding new `metrics` or `graphfcns` +## New behaviour Our intention with `SWMManywhere` is that a high level of customisation to suit -your needs +your needs may be achieved by adding new `graphfcns` or new `metrics`, see +below. Other new behaviour may be tagged with `enhancement`, though please +check existing [issues](https://github.com/ImperialCollegeLondon/SWMManywhere/issues) +to see if something similar already exists. -Is there something in the water cycle that you would like to represent that is not included in `WSIMOD`? Whatever it is, you are probably not alone! If there is not one already, please create an [issue](https://imperialcollegelondon.github.io/wsi/issues) where we can discuss it. Do this _before_ you start developing as others may be working on the same thing! +### Take a graph give a graph: `graphfcns` -Although the development of new functionality will depend highly on the case, there are a few generalisable points to bear in mind: +All transformations that take place do so on graph functions, you can change +the order in which these are executed and add new ones. If you want a +`graphfcn` that does a new thing, please create an issue to discuss with the +label `graphfcn`. If a single new `graphfcn` is not sufficient to capture the +transformations that you'd like to apply, more may be needed. If this is the +case, please first create an issue labelled with `enhancement` detailing the +thing that you would like to capture, where we will discuss what `graphfcns` +are needed, and use this issue to coordinate. -- `WSIMOD` is highly object-oriented, thus, we will always try to implement a new component as a subclass of the closest component. We will collaboratively discuss this in the issue. -- Our [documentation](https://imperialcollegelondon.github.io/wsi) relies heavily on use of docstrings, make sure to format it following the [Google Python style](https://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_google.html), see the source code of [`Land.__init__`](https://imperialcollegelondon.github.io/wsi/reference-land/#wsimod.nodes.land.Land.__init__) for an example. An admin will compile the documentation, but you can create your own pages to be added by following the directions [below](#create-documentation). -- We are incredibly grateful for contributions that include new [tutorials](https://imperialcollegelondon.github.io/wsi/tutorials/) or [how-to's](https://imperialcollegelondon.github.io/wsi/how-to/), whether for new or existing functionality. Our use of the [mkdocs-jupyter](https://github.com/danielfrg/mkdocs-jupyter) extension enables notebooks to form pages in the documentation, but that can also serve as downloadable examples that people can run. -- Design new tests that instantiate your new functionality and test that it produces a specified response. New tests are stored in the `wsi/tests/` folder. +### Evaluate against real data with: `metrics` + +We have provided a large set of metrics against which a synthetic graph's +performance may be evaluated if a real network is provided. If you want to +create a new `metric`, please create an issue to discuss with the label +`metric`. ## Installation for development -To install WSIMOD in development mode, first you will need a virtual environment. Here we use a `conda` environment which let us use the version of python we want to use, -but you can use any other tool you are familiar with. Just make sure you use a version of Python compatible with WSIMOD. +To install `SWMManywhere` in development mode, first you will need a virtual +environment. Here we use a `conda` environment which let us use the version of +python we want to use, but you can use any other tool you are familiar with. +Just make sure you use a version of Python compatible with SWMManywhere. ```bash conda create --name wsimod python=3.10 -conda activate wsimod +conda activate swmmanywhere ``` -Once in the environment, you need to clone the WSIMOD GitHub repository locally and move into the right folder. You will need `git` for that, installed either following the [official instructions](https://git-scm.com/downloads) or with `conda install git`, if you use `conda`. +Once in the environment, you need to clone the `SWMManywhere` GitHub repository +locally and move into the right folder. You will need `git` for that, installed +either following the [official instructions](https://git-scm.com/downloads) or +with `conda install git`, if you use `conda`. ```bash -git clone https://github.com/ImperialCollegeLondon/wsi.git -cd wsi +git clone https://github.com/ImperialCollegeLondon/SWMManywhere.git +cd swmmanywhere ``` -We use [`pip-tools`](https://pip-tools.readthedocs.io/en/latest/) to ensure consistency in the development process, ensuring all people contributing to WSIMOD uses the same versions for all the dependencies, which minimiese the conflicts. To install the development dependencies and then WISMO in development mode run: +We use [`pip-tools`](https://pip-tools.readthedocs.io/en/latest/) to ensure +consistency in the development process, ensuring all people contributing to +`SWMManywhere` uses the same versions for all the dependencies, which minimiese +the conflicts. To install the development dependencies and then `SWMManywhere` +in development mode run: ```bash pip install -r requirements-dev.txt pip install -e . ``` -You can also install the dependencies required to run the demos and tutorials with: - -```bash -pip install -r requirements-demos.txt -``` - ## Quality assurance and linting -WSIMOD uses a collection of tools that ensure that a specific code style and formatting is follow throughout the software. The tools we used for that are [`ruff`](https://docs.astral.sh/ruff/) and [`markdownlint`](https://github.com/igorshubovych/markdownlint-cli). You do not need to run them manually - unless you want to - but rather they are run automatically every time you make a commit thanks to `pre-commit`. - -`pre-commit` should already have been installed when installing the `dev` dependencies, if you followed the instructions above, but you need to activate the hooks that `git` will run when making a commit. To do that just run: +'SWMManywhere' uses a collection of tools that ensure that a specific code +style and formatting is follow throughout the software. The tools we used for +that are [`ruff`](https://docs.astral.sh/ruff/), +[`markdownlint`](https://github.com/igorshubovych/markdownlint-cli), +[`mypy`](https://github.com/pre-commit/mirrors-mypy), +[`refurb`](https://github.com/dosisod/refurb), +[`codespell`](https://github.com/codespell-project/codespell), +[`pyproject-fmt`](https://github.com/tox-dev/pyproject-fmt). +You do not need to run them manually - unless you want to - but rather they are +run automatically every time you make a commit thanks to `pre-commit`. + +`pre-commit` should already have been installed when installing the `dev` +dependencies, if you followed the instructions above, but you need to activate +the hooks that `git` will run when making a commit. To do that just run: ```bash pre-commit install ``` -You can customise the checks that `ruff` will make with the settings in `pyproject.toml`. For `markdownlint`, you need to oedit the arguments included in the .`pre-commit-config.yaml` file. +You can customise the checks that `ruff` will make with the settings in +`pyproject.toml`. For `markdownlint`, you need to oedit the arguments included +in the .`pre-commit-config.yaml` file. ## Testing and coverage -WSIMOD uses `pytests` as testing suite. You can run tests by navigating to the folder and running: +`SWMManywhere` uses `pytests` as testing suite. You can run tests by navigating +to the folder and running: ```bash pytest # run all tests @@ -87,26 +116,11 @@ And generate a new coverage html for the documentation with coverage html ``` -## Create documentation - -If you want to compile new documentation you will need some additional packages, installed with: - -```bash -pip install -r requirements-doc.txt -``` - -From here, you can make changes to the documentation pages in `docs` and view how they appear by navigating to and hosting them locally: - -```bash -mkdocs serve -``` - -If compiling and deploying documentation, you will need to have `git` installed (see above). Then: - -```bash -mkdocs gh-deploy -``` - ## Changing dependencies -Is as the development process moves forward you find you need to add a new dependency, just add it to the relevant section of the `pyproject.toml` file and then run `pip-compile` as required to regenerate the different `requirements.txt` files. Read the [`pip-tools` documentation](https://pip-tools.readthedocs.io/en/latest/) for more information on the process. +Is as the development process moves forward you find you need to add a new +dependency, just add it to the relevant section of the `pyproject.toml` file +and then run `pip-compile` as required to regenerate the different +`requirements.txt` files. Read the +[`pip-tools` documentation](https://pip-tools.readthedocs.io/en/latest/) for +more information on the process. From c643a60057f7ac0c7b44906ef286346c6a2eb119 Mon Sep 17 00:00:00 2001 From: Dobson Date: Thu, 21 Mar 2024 12:08:58 +0000 Subject: [PATCH 09/17] Create HISTORY.md --- swmmanywhere/HISTORY.md | 5 +++++ 1 file changed, 5 insertions(+) create mode 100644 swmmanywhere/HISTORY.md diff --git a/swmmanywhere/HISTORY.md b/swmmanywhere/HISTORY.md new file mode 100644 index 00000000..9fbc74fe --- /dev/null +++ b/swmmanywhere/HISTORY.md @@ -0,0 +1,5 @@ +# History + +## 0.1.0 (date) + +- First release goes here From c0f32a5f78f021c3ecaa76ce6c24d73724bc73c4 Mon Sep 17 00:00:00 2001 From: barneydobson Date: Thu, 21 Mar 2024 12:10:27 +0000 Subject: [PATCH 10/17] Update CONTRIBUTING.md --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 90cd6504..bb60ceb6 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -70,7 +70,7 @@ pip install -e . ## Quality assurance and linting -'SWMManywhere' uses a collection of tools that ensure that a specific code +`SWMManywhere` uses a collection of tools that ensure that a specific code style and formatting is follow throughout the software. The tools we used for that are [`ruff`](https://docs.astral.sh/ruff/), [`markdownlint`](https://github.com/igorshubovych/markdownlint-cli), From 69968f580137aef875f2e97ba2c4abc2ea7d95b6 Mon Sep 17 00:00:00 2001 From: barneydobson Date: Thu, 21 Mar 2024 12:11:27 +0000 Subject: [PATCH 11/17] Update CONTRIBUTING.md --- CONTRIBUTING.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index bb60ceb6..fcfe7f3a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -80,6 +80,11 @@ that are [`ruff`](https://docs.astral.sh/ruff/), [`pyproject-fmt`](https://github.com/tox-dev/pyproject-fmt). You do not need to run them manually - unless you want to - but rather they are run automatically every time you make a commit thanks to `pre-commit`. +If you want to run them manually before comitting, you can do so with: + +```bash +pre-commit run --all-files +``` `pre-commit` should already have been installed when installing the `dev` dependencies, if you followed the instructions above, but you need to activate From 5d3d5df60b89e38b6c3750abf5b4d33f743b5405 Mon Sep 17 00:00:00 2001 From: barneydobson Date: Thu, 21 Mar 2024 12:12:23 +0000 Subject: [PATCH 12/17] Update CONTRIBUTING.md --- CONTRIBUTING.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index fcfe7f3a..71ee1464 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -94,9 +94,9 @@ the hooks that `git` will run when making a commit. To do that just run: pre-commit install ``` -You can customise the checks that `ruff` will make with the settings in -`pyproject.toml`. For `markdownlint`, you need to oedit the arguments included -in the .`pre-commit-config.yaml` file. +You can customise the checks that `ruff`, `mypy`, and `refurb` will make with +the settings in `pyproject.toml`. For `markdownlint`, you need to edit the +arguments included in the .`pre-commit-config.yaml` file. ## Testing and coverage From eab623a3897156600e1e5a1d5a2d18e80626a2f2 Mon Sep 17 00:00:00 2001 From: Dobson Date: Thu, 21 Mar 2024 12:17:14 +0000 Subject: [PATCH 13/17] Update CONTRIBUTING.md --- CONTRIBUTING.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 71ee1464..16ede4ab 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -80,7 +80,7 @@ that are [`ruff`](https://docs.astral.sh/ruff/), [`pyproject-fmt`](https://github.com/tox-dev/pyproject-fmt). You do not need to run them manually - unless you want to - but rather they are run automatically every time you make a commit thanks to `pre-commit`. -If you want to run them manually before comitting, you can do so with: +If you want to run them manually before committing, you can do so with: ```bash pre-commit run --all-files @@ -94,8 +94,8 @@ the hooks that `git` will run when making a commit. To do that just run: pre-commit install ``` -You can customise the checks that `ruff`, `mypy`, and `refurb` will make with -the settings in `pyproject.toml`. For `markdownlint`, you need to edit the +You can customise the checks that `ruff`, `mypy`, and `refurb` will make with +the settings in `pyproject.toml`. For `markdownlint`, you need to edit the arguments included in the .`pre-commit-config.yaml` file. ## Testing and coverage From 356014ece06436e2b611a09badb9609bc3e43ca9 Mon Sep 17 00:00:00 2001 From: Dobson Date: Thu, 21 Mar 2024 13:02:30 +0000 Subject: [PATCH 14/17] Update CONTRIBUTING.md --- CONTRIBUTING.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 16ede4ab..e09f909f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -4,7 +4,7 @@ Thank you for considering contributing to `SWMManywhere`. ## Bugs -Please create a new [issues](https://github.com/ImperialCollegeLondon/SWMManywhere/issues) +Please create a new issues (insert link when published) if you may have found a bug. Please describe the bug and instructions on recreating it (including OS and Python version). Label the issue with `bug`. @@ -14,7 +14,7 @@ Python version). Label the issue with `bug`. Our intention with `SWMManywhere` is that a high level of customisation to suit your needs may be achieved by adding new `graphfcns` or new `metrics`, see below. Other new behaviour may be tagged with `enhancement`, though please -check existing [issues](https://github.com/ImperialCollegeLondon/SWMManywhere/issues) +check existing issues (insert link when published) to see if something similar already exists. ### Take a graph give a graph: `graphfcns` From bd999d461afc0ad8c6115f5d4ce892fda3aa0026 Mon Sep 17 00:00:00 2001 From: Dobson Date: Mon, 25 Mar 2024 09:36:08 +0000 Subject: [PATCH 15/17] Update CONTRIBUTING.md --- CONTRIBUTING.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index e09f909f..935e4079 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -108,6 +108,14 @@ pytest # run all tests pytest tests/test_file.py # run a specific file's tests ``` +By default the `tests/tests_prepare_data.py` does not test the actual downloads +themselves (since this relies on external APIs actually working at the time of +testing), however downloads can be enabled when testing: + +```bash +pytest tests/tests_prepare_data.py -m downloads +``` + You can check the coverage for these tests by running: ```bash From 7e6774d71282dd37a99401e71ae1ccc2e47087b3 Mon Sep 17 00:00:00 2001 From: barneydobson Date: Mon, 25 Mar 2024 13:49:12 +0000 Subject: [PATCH 16/17] Update CONTRIBUTING.md --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 935e4079..45b19fa4 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -43,7 +43,7 @@ python we want to use, but you can use any other tool you are familiar with. Just make sure you use a version of Python compatible with SWMManywhere. ```bash -conda create --name wsimod python=3.10 +conda create --name swmmanywhere python=3.10 conda activate swmmanywhere ``` From 532692c02396fd7ade9d407b5438a8301fdae359 Mon Sep 17 00:00:00 2001 From: barneydobson Date: Mon, 25 Mar 2024 14:38:28 +0000 Subject: [PATCH 17/17] Update CONTRIBUTING.md --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 45b19fa4..01728e57 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -64,7 +64,7 @@ the conflicts. To install the development dependencies and then `SWMManywhere` in development mode run: ```bash -pip install -r requirements-dev.txt +pip install -r dev-requirements.txt pip install -e . ```