Skip to content

Commit

Permalink
TL: removed superfluous dollars on doc
Browse files Browse the repository at this point in the history
  • Loading branch information
tlunet committed Jun 22, 2024
1 parent 4e8a008 commit 0ed7326
Show file tree
Hide file tree
Showing 4 changed files with 28 additions and 28 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ which are key elements for Spectral Deferred Correction (SDC), or more general I
## Installation

```bash
$ pip install qmat
pip install qmat
```

🔍 See more [detailed instructions for conda environment, development, ...](https://qmat.readthedocs.io/en/latest/installation.html)
Expand Down
32 changes: 16 additions & 16 deletions docs/devdoc/testing.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,14 +8,14 @@ For reproducibility, it is recommended to use a dedicated environment to install
You can do that by running from `qmat` root folder :

```bash
$ python -m venv env
python -m venv env
```

$\Rightarrow$ this will create a `env` folder in `qmat` root folder (ignored by `git`),
that you can activate using :

```bash
$ source ./env/bin/activate
source ./env/bin/activate
```

> 🔔 In case you have the `base` `conda` environment as default on your computer,
Expand All @@ -27,8 +27,8 @@ Those can be installed one by one (if not already on your system),
or use this (dirty) shortcut by running from the `qmat` root folder :

```bash
$ pip install .[test] # install qmat locally and all test dependencies
$ pip uninstall qmat # remove the frozen qmat package installed locally
pip install .[test] # install qmat locally and all test dependencies
pip uninstall qmat # remove the frozen qmat package installed locally
```

> 📣 Remember that the [recommended installation approach for developer](../installation) is to use a simple modification of the `PYTHONPATH` environment variable.
Expand All @@ -38,7 +38,7 @@ $ pip uninstall qmat # remove the frozen qmat package installed locally
The first thing to do (from the root `qmat` repo) is to run :

```bash
$ python -c "import qmat"
python -c "import qmat"
```

This will trigger the [registration mechanism](./structure) that test the code structure at import,
Expand All @@ -48,7 +48,7 @@ and ensures that all generators are correctly implemented
Then run the full test series with :

```bash
$ pytest -v ./tests
pytest -v ./tests
```

This will check :
Expand All @@ -64,21 +64,21 @@ So you may not want to run all of those every time you do a small modification s
Here are a few tricks you can use :

```bash
$ pytest -v -x ./tests # interrupt test on the first encountered error
$ pytest -v ./tests/test_1_nodes.py # run only one test file
$ pytest -v ./tests/test_qcoeff # run only one folder
$ pytest -v ./tests/test_1_nodes.py::testGauss # run only one test function
$ pytest -v ./tests/test_1_nodes.py::testGauss[LEGENDRE] # run only one test function with one given configuration
pytest -v -x ./tests # interrupt test on the first encountered error
pytest -v ./tests/test_1_nodes.py # run only one test file
pytest -v ./tests/test_qcoeff # run only one folder
pytest -v ./tests/test_1_nodes.py::testGauss # run only one test function
pytest -v ./tests/test_1_nodes.py::testGauss[LEGENDRE] # run only one test function with one given configuration
```

## Check code coverage

Once all test pass, you may check locally coverage by running (from the root folder) :

```bash
$ ./test.sh
$ coverage combine
$ python -m coverage html
./test.sh
coverage combine
python -m coverage html
```

This generates a html coverage report in `htmlcov/index.html` that you can read using your favorite web browser.
Expand All @@ -88,8 +88,8 @@ This generates a html coverage report in `htmlcov/index.html` that you can read
All notebooks are located in the [notebook docs folder](../notebooks). You can first check if they can be executed properly by running :

```bash
$ cd docs/notebooks
$ ./run-sh --all
cd docs/notebooks
./run-sh --all
```

💡 To execute only one notebook, simply run _e.g_ :
Expand Down
10 changes: 5 additions & 5 deletions docs/devdoc/updateDoc.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,8 @@ You can install those using your favorite python package manager (`pip`, `conda`
Then to generate the documentation website locally, simply run (from the root `qmat` repo) :

```bash
$ cd docs
$ make html
cd docs
make html
```

This builds the sphinx documentation automatically in a `_build` folder,
Expand All @@ -24,14 +24,14 @@ When changing a [notebook tutorial](../notebooks), you should also regenerate it
You can do that by running :

```bash
$ cd notebooks
$ ./run.sh $NOTEBOOK_FILE
cd notebooks
./run.sh $NOTEBOOK_FILE
```

If you modified several notebooks, and as a safety, it is also possible to regenerate all doing :

```bash
$ ./run.sh --all
./run.sh --all
```

> 📣 When modifying only the markdown text in the notebook, it is not necessary to regenerate the notebook(s).
Expand Down
12 changes: 6 additions & 6 deletions docs/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,25 +32,25 @@ dependencies:
In case you want the latest revision (or a specific branch), you can directly clone the sources from `github` :

```bash
$ git clone https://github.com/Parallel-in-Time/qmat.git
git clone https://github.com/Parallel-in-Time/qmat.git
```

If you **want to use the package only**, simply use the `pip` local installer directly :

```bash
$ cd qmat # go into the local git repo
$ pip install .
cd qmat # go into the local git repo
pip install .
```

For **developers who want to contribute**, recommended approach is to add
the code folder to your `PYTHONPATH` (if not done already by your IDE), _e.g_ :

```bash
$ cd qmat # go into the local git repo (if not already there)
$ export PYTHONPATH=$PYTHONPATH:$(pwd)
cd qmat # go into the local git repo (if not already there)
export PYTHONPATH=$PYTHONPATH:$(pwd)
```

> 🔔 Using `$ pip install -e .` is also possible for developments, but then you have a persistent installation that you should be aware of ...
> 🔔 Using `pip install -e .` is also possible for developments, but then you have a persistent installation that you should be aware of ...



Expand Down

0 comments on commit 0ed7326

Please sign in to comment.