Thanks to visit codestin.com
Credit goes to github.com

Skip to content

docs: 📝 Add further explenation for conda installation #520

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Dec 15, 2022
Merged

docs: 📝 Add further explenation for conda installation #520

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,16 @@

> See also: [https://github.com/Anselmoo/spectrafit/releases][1]

## _Unreleased_

- Add `SpectraFit` to [Conda-Forge][2] as [spectrafit][3] package.
- Extend `SpectraFit` to print current peak values as `dataframe`
in Jupyter-Notebook.

## v0.13.1

- Fix crashed regression analysis due to _negative_ values in the `y`-data.

## v0.13.0

---
Expand Down
56 changes: 56 additions & 0 deletions INSTALLATION.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,59 @@ To keep the system environment clean, the installation is done via the:
spectrafit --help
```

For include the `jupyter` support, the following command can be used:

```terminal

conda install -c conda-forge spectrafit-jupyter

# To test
python -c "from spectrafit.plugins.notebook import SpectraFitNotebook"
```

Extended documentation about the installation of `SpectraFit` via conda can
be found [here][7]. In general, the following command can be useful for
working with conda:

```terminal
conda config --add channels conda-forge
conda config --set channel_priority strict
```

=== "Poetry"

For installing `SpectraFit` via [Poetry][8], first `SpectraFit` has to be
downloaded or cloned from the [GitHub repository][9]. Optionally, the
`SpectraFit` repo has to be unpacked. Next, `poetry` has to be installed
via `pip`:

```terminal
pip install poetry
```

or via `conda`:

```terminal
conda install -c conda-forge poetry
```
_Installation_:

```terminal
poetry install -E jupyter
```
_Usage_:

```terminal
poetry run spectrafit --help
```

or using the `poetry shell`:

```terminal
poetry shell
spectrafit --help
```

_Result_:

```terminal
Expand Down Expand Up @@ -109,3 +162,6 @@ available plugins are:
[4]: https://github.com/Anselmoo/spectrafit/pkgs/container/spectrafit
[5]: https://github.com/jupyter/docker-stacks/blob/main/scipy-notebook/Dockerfile
[6]: ../../plugins/jupyter-spectrafit-interface
[7]: https://github.com/conda-forge/spectrafit-feedstock
[8]: https://python-poetry.org/docs/
[9]: https://github.com/Anselmoo/spectrafit/
12 changes: 10 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ via pip:
```terminal
pip install spectrafit

# with suppot for Jupyter Notebook
# with support for Jupyter Notebook

pip install spectrafit[jupyter]

Expand All @@ -48,10 +48,18 @@ pip install spectrafit[jupyter]
pip install spectrafit --upgrade
```

via conda:
via conda, see also [conda-forge](https://github.com/conda-forge/spectrafit-feedstock):

```terminal
conda install -c conda-forge spectrafit

# with support for Jupyter Notebook

conda install -c conda-forge spectrafit-jupyter

# with all upcomming features

conda install -c conda-forge spectrafit-all
```

## Usage
Expand Down