Skip to content

Commit

Permalink
Ran pre-commit & modified README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
marcosertoli committed Jul 10, 2024
1 parent 3694b00 commit bc3042a
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 10 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/publish.yml
Original file line number Diff line number Diff line change
Expand Up @@ -27,4 +27,4 @@ jobs:
run: |
python -m build
- name: Publish package distributions to PyPI
uses: pypa/gh-action-pypi-publish@release/v1
uses: pypa/gh-action-pypi-publish@release/v1
14 changes: 5 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,11 @@ Status](https://readthedocs.org/projects/indica-ukaea/badge/?version=latest)](ht

InDiCA (**In**tegrated **Di**agnosti**C** **A**nalysis) is a tool which allows to perform and combine the analysis of a large number of different diagnostics from Magnetic Confined Fusion (MCF) plasma devices. It will consist of a library of functions to analyse different diagnostic systems under a common framework, and a set of workflows to combine these measurements. <!--- Test for pre-commit -->

The overall design work has been completed and the general functionality implemented, but the library is still under active development. In addition to the (rapidly changing) code, this repository holds the documentation for this project, [which can be found on
ReadTheDocs](https://indica-ukaea.readthedocs.io/en/latest/), which is also still (rapidly) changing.
The overall design work has been completed and the general functionality implemented, but the library is still under active development.
<!--In addition to the (rapidly changing) code, this repository holds the documentation for this project, [which can be found on ReadTheDocs](https://indica-ukaea.readthedocs.io/en/latest/), which is also still (rapidly) changing.-->

## Install
1. Make sure pip is up-to-date:
## Creation of development environment
1. Upgrade pip:
- *pip install --upgrade pip*

2. Create a virtual environment with python 3.11 and activate it, e.g. using conda:
Expand All @@ -24,18 +24,14 @@ ReadTheDocs](https://indica-ukaea.readthedocs.io/en/latest/), which is also stil
- *pip install poetry==1.7*
- *poetry update*

4. For mdsplus building and installation:
4. For mdsplus building and installation, e.g. from a local mdsplus directory:
- *cp -r /usr/local/mdsplus/mdsobjects/python mdsPython*
- *cd mdsPython*
- *python setup.py build*
- *python setup.py install*
- *cd ../*
- *rm -r mdsPython*

5. Optional: For installing InDiCA as a package:
- *cd Indica*
- *python -m pip install .*

## License

InDiCA is distributed under the [GNU General Public License version
Expand Down

0 comments on commit bc3042a

Please sign in to comment.