Skip to content

Commit

Permalink
Reduce page artifact file size
Browse files Browse the repository at this point in the history
  • Loading branch information
sitic committed Oct 11, 2024
1 parent 5a4d013 commit a54b5f2
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 4 deletions.
2 changes: 2 additions & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,8 @@ jobs:
run: |
jcache notebook -p docs/.jupyter_cache list
python -m sphinx -b dirhtml --doctree-dir docs/doctrees docs docs/_build
find docs/_build -iname '.jupyter_cache' # should be empty but sometimes it's not
find docs/_build -iname '.jupyter_cache' -exec rm -rf {} \;
env:
TQDM_MININTERVAL: 20

Expand Down
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
Pre-built binaries can be installed using pip:

```bash
pip install opticalmapping[all]
pip install "opticalmapping[all]"
```

The above command will install optimap and all recommended dependencies including OpenCV and PySide2. If you wish to install your own version of OpenCV (e.g. for CUDA support) or Qt implementation use:
Expand All @@ -33,14 +33,14 @@ pip install opticalmapping
To update optimap to the latest version run

```bash
pip install --upgrade opticalmapping[all]
pip install --upgrade "opticalmapping[all]"
```

## About optimap

`optimap` is an interactive, script or notebook-based software library created for cardiovascular scientists in particular, but might also be useful for scientists in other fields. For instance, when performing calcium imaging or physiological research with moving cells or tissues. It is designed to be a flexible and customizable analysis workflow toolkit, which allows for a wide range of analyses and visualizations. See the [Tutorials](https://cardiacvision.github.io/optimap/main/tutorials/) for examples and more information about the usage of `optimap`. The tutorials can be downloaded by clicking on the link in the green box at the top of each tutorial page.

`optimap` is developed by members of the [Cardiac Vision Laboratory](https://cardiacvision.ucsf.edu) at the [University of California, San Franicsco](https://www.ucsf.edu). It is open-source, freely available, and relies on open-source packages such as NumPy, SciPy, Matplotlib and OpenCV.
`optimap` is developed by Jan Lebert and Jan Christoph of the [Cardiac Vision Laboratory](https://cardiacvision.ucsf.edu) at the [University of California, San Franicsco](https://www.ucsf.edu). It is open-source, freely available, and relies on open-source packages such as NumPy, SciPy, Matplotlib and OpenCV.

## Links

Expand Down
2 changes: 1 addition & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -144,7 +144,7 @@ def remove_markdown(cell):
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
#
html_copy_source = True # needed for download notebook button
html_copy_source = False
html_static_path = ["_static"]
html_css_files = [
"custom.css",
Expand Down

0 comments on commit a54b5f2

Please sign in to comment.