Skip to content

Commit

Permalink
add pyincore-data instruction
Browse files Browse the repository at this point in the history
  • Loading branch information
longshuicy committed Jul 17, 2024
1 parent 84ca5b1 commit 21d621e
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 2 deletions.
4 changes: 4 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,10 @@ All notable changes to the INCORE documents generated by Sphinx package will be
The format is based on [Keep a Changelog](http://keepachangelog.com/)
and this project adheres to [Semantic Versioning](http://semver.org/).

## [Unreleased]

### Added
- Instruction to install pyincore-data [#412](https://github.com/IN-CORE/pyincore/issues/412)

## [4.12.0] - 2024-06-12

Expand Down
18 changes: 16 additions & 2 deletions manual_jb/content/getting_started.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,13 +85,27 @@ If you don't have Miniconda installed, do the following steps.
conda install -c in-core pyincore-viz --solver=libmamba
```

If the installed pyincore or pyincore-viz version is not the latest or lower than the desired one, specify the version number in installation command.
The **pyIncore-data** package, available in the in-core conda channel, assists in preparing data for use in
**pyIncore**. When a user installs the **pyIncore-data** module, the **pyIncore** package is also installed as a
dependency.
```
conda install -c in-core pyincore-data
```
Similarly, you can use the libmamba solver flag to resolve the dependencies by running the following command:

```
conda install -c in-core pyincore-data --solver=libmamba
```

If the installed pyincore, pyincore-viz, pyincore-data version is not the latest or lower than the desired one,
specify the version number in installation command. e.g.
```
conda install -c in-core pyincore=1.14.0 (or your version of choice)
```
Version information for pyincore and pyincore-viz can be found in
Version information for pyincore, pyincore-viz, and pyincore-data can be found in
- https://anaconda.org/IN-CORE/pyincore
- https://anaconda.org/IN-CORE/pyincore-viz
- https://anaconda.org/IN-CORE/pyincore-data


6. Install Jupyter Notebook. Jupyter Notebook is already installed with Anaconda distribution; it has to be installed separately in your virtual environment on Miniconda:
Expand Down

0 comments on commit 21d621e

Please sign in to comment.