Skip to content

Commit

Permalink
Merge pull request #226 from neutronimaging/ewm7496-docs-updateLinks
Browse files Browse the repository at this point in the history
Update README
  • Loading branch information
KedoKudo authored Oct 15, 2024
2 parents ea6f99d + 0877096 commit 0c53d55
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 12 deletions.
10 changes: 3 additions & 7 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -17,15 +17,11 @@ repos:
hooks:
- id: ruff
args: [--fix, --exit-non-zero-on-fix]
exclude: |
"tests/cis_tests/.*"
"notebooks/"
exclude: "tests/cis_tests/.*"
- id: ruff-format
exclude: |
"tests/cis_tests/.*"
"notebooks/"
exclude: "tests/cis_tests/.*"
- repo: https://github.com/codespell-project/codespell
rev: v2.3.0
hooks:
- id: codespell
exclude: "notebooks/"
exclude: "notebooks/"
17 changes: 12 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Python Notebooks [![Build Status](https://www.travis-ci.com/neutronimaging/python_notebooks.svg?branch=master)](https://www.travis-ci.com/neutronimaging/python_notebooks) [![DOI](https://zenodo.org/badge/99945953.svg)](https://zenodo.org/badge/latestdoi/99945953)
# Python Notebooks [![DOI](https://zenodo.org/badge/99945953.svg)](https://zenodo.org/badge/latestdoi/99945953)



Expand All @@ -13,6 +13,13 @@ To learn how to access or install the notebooks, and how to run them, refer to t

![Screen Shot 2021-06-11 at 8 03 33 AM](https://user-images.githubusercontent.com/1138324/121683900-000cc080-ca8c-11eb-815f-5ff52731dba7.png)

## Instrument References
For more information about the facility and instruments, navigate to the following links:
- [ORNL Neutron Imaging Website](https://neutronimaging.ornl.gov/)
- [Multimodal Advanced Radiography Station (MARS)](https://neutrons.ornl.gov/mars)
- [Versatile Neutron Imaging Instrument (VENUS)](https://neutrons.ornl.gov/venus)


## How to contribute back

You can contribute back to this repo by
Expand Down Expand Up @@ -51,8 +58,8 @@ $ cd notebooks
$ export PYTHONPATH=$PWD:$PYTHONPATH
$ pytest
```
## Deployment repos
## Deployment

An updated deployment strategy is underway.

- Repo in charge of deploying the notebooks: [jupyter-notebooks-deploy](https://code.ornl.gov/sns-hfir-scse/deployments/jupyter-notebooks-deploy)
- Repo in charge of updating the conda environments in target machines (such as the analysis
cluster and the jupyter-notebooks nodes): [imaging-conda-deploy](https://code.ornl.gov/sns-hfir-scse/deployments/imaging-conda-deploy)
Currently, notebooks are distributed directly by the Computational Instrument Scientist.

1 comment on commit 0c53d55

@github-actions
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

GitLab pipeline with NOTEBOOK_COLLECTION_NAME=IPTS_notebooks_testing submitted for commit "https://code.ornl.gov/sns-hfir-scse/deployments/jupyter-notebooks-deploy/-/pipelines/625719"

Please sign in to comment.