Skip to content
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

Add conda install instructions #14

Merged
merged 5 commits into from
Jan 2, 2024
Merged

Add conda install instructions #14

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
c10bb0b
Add conda install instructions
IAlibay Dec 29, 2023
8969f65
changelog
IAlibay Dec 29, 2023
69aaf8c
Merge branch 'main' into conda-docs
orbeckst Jan 2, 2024
d23b9cd
Update README.md with conda installation instructions
orbeckst Jan 2, 2024
37d5cd6
Update installation in README.md
orbeckst Jan 2, 2024
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
3 changes: 2 additions & 1 deletion CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,8 @@ The rules for this file:
- IAlibay

### Added
- Support for Python 3.12
- Added conda-forge install instruction to docs (Issue #13, PR #14)
- Support for Python 3.12 (Issue #11, PR #12)

### Fixed
- Changed logger to no longer point to MDAnalysis.analysis
Expand Down
13 changes: 13 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,19 @@ for `pip`.

Ensure that you have [conda](https://docs.conda.io/projects/conda/en/latest/user-guide/install/index.html) installed.

##### From conda-forge

You can install [pathsimanalysis from the conda-forge channel](https://anaconda.org/conda-forge/pathsimanalysis) with
Copy link
Member Author

Choose a reason for hiding this comment

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

Oops sorry for the double post - looks like the previous one got added to a commit instead of the PR.

My question was whether this might conflict with the "from source" comment above.

Copy link
Member

Choose a reason for hiding this comment

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

Yes, I guess, but the pip installation (which may use wheels) was already misleading. I just changed it into package/source.

```
conda install -c conda-forge pathsimanalysis
```
or alternatively with `mamba` if you have it installed:

```
mamba install -c conda-forge pathsimanalysis
```

##### From source inside a conda ennvironment
Create a virtual environment and activate it:

```
Expand Down
17 changes: 17 additions & 0 deletions docs/source/getting_started.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,23 @@ This page details how to get started with PathSimAnalysis.
Installation
------------

Conda / Mamba
-------------

You can install `pathsimanalysis from the conda-forge channel <https://anaconda.org/conda-forge/pathsimanalysis>`_ with:

.. code-block:: sh

conda install -c conda-forge pathsimanalysis


or alternatively with :program:`mamba` if you have it installed:

.. code-block:: sh

mamba install -c conda-forge pathsimanalysis


PyPi
~~~~

Expand Down
Loading