Skip to content

Commit

Permalink
Update installation guide.
Browse files Browse the repository at this point in the history
  • Loading branch information
Weizhe-Chen committed Aug 30, 2023
1 parent 42d007c commit d180911
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 5 deletions.
15 changes: 11 additions & 4 deletions docs/developers/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,6 @@ Please follow these guidelines when submitting code changes to the repository.

### Code Formatting

- Use double quotes for string literals.
- Use [yapf](https://github.com/google/yapf) to format the code.
- Use [isort](https://pycqa.github.io/isort/) to sort the imports

Expand All @@ -103,14 +102,14 @@ Please follow these guidelines when submitting code changes to the repository.

### Code Quality

- Write [pytest](https://docs.pytest.org/en/7.2.x/) unit tests for all code changes.
- Use [pyright](https://github.com/microsoft/pyright) for static type checking.
- Use comments to provide context and explain complex code.
- Docstrings follow [Google style](https://google.github.io/styleguide/pyguide.html)
- Write code that is easy to read and understand.
- Write code that is easy to modify and maintain.
- Avoid using global variables and functions.
- Write [pytest](https://docs.pytest.org/en/7.2.x/) unit tests for all code changes.
- Use type hints to improve readability and maintainability.
- Use [pyright](https://github.com/microsoft/pyright) for static type checking.

### Exception Handling

Expand Down Expand Up @@ -140,8 +139,16 @@ Below is a summary of the development tools and their purposes.

These tools can be installed by

```bash
```
pip install -r requirements_dev.txt
```

Following these guidelines will help us ensure that the PyPolo codebase remains consistent, maintainable, and of high quality.

### Building Documentation Locally

```
mamba install lxml
pip install -r docs/requirements.txt
mkdocs serve
```
1 change: 1 addition & 0 deletions docs/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,7 @@ Now we can create a virtual environment for the PyPolo project:
## Install PyPolo

```
mamba install -c conda-forge pyvista
git clone https://github.com/Weizhe-Chen/PyPolo.git
cd PyPolo
pip install -e .
Expand Down
1 change: 0 additions & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,6 @@
"tensorboard",
"matplotlib",
"tqdm",
"pyvista",
"imageio-ffmpeg",
]

Expand Down

0 comments on commit d180911

Please sign in to comment.