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

Update conda install documentation #178

Merged
merged 4 commits into from
Nov 7, 2024
Merged

Update conda install documentation #178

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
1e82025
update conda install docs
pluflou Nov 7, 2024
5e389d9
fix conda badges
pluflou Nov 7, 2024
e6d7074
fix conda badges
pluflou Nov 7, 2024
66ca781
fix conda badges
pluflou Nov 7, 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 MANIFEST.in
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
prune statistical-clear-sky/fixtures
prune notebooks
prune docs
prune docs
prune tests
23 changes: 13 additions & 10 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,17 +22,17 @@
<a href="https://pypi.org/project/solar-data-tools/">
<img src="https://img.shields.io/pypi/v/solar-data-tools.svg" alt="latest release" />
</a>
<a href="https://anaconda.org/slacgismo/solar-data-tools">
<img src="https://anaconda.org/slacgismo/solar-data-tools/badges/version.svg" />
<a href="https://anaconda.org/conda-forge/solar-data-tools">
<img src="https://anaconda.org/conda-forge/solar-data-tools/badges/version.svg" />
</a>
<a href="https://anaconda.org/slacgismo/solar-data-tools">
<img src="https://anaconda.org/slacgismo/solar-data-tools/badges/latest_release_date.svg" />
<a href="https://anaconda.org/conda-forge/solar-data-tools">
<img src="https://anaconda.org/conda-forge/solar-data-tools/badges/latest_release_date.svg" />
</a>
</tr>
<tr>
<td>License</td>
<td>
<a href="https://github.com/slacgismo/solar-data-tools/blob/master/LICENSE">
<a href="https://github.com/slacgismo/solar-data-tools/blob/main/LICENSE">
<img src="https://img.shields.io/pypi/l/solar-data-tools.svg" alt="license" />
</a>
</td>
Expand Down Expand Up @@ -70,8 +70,8 @@
<tr>
<td>Conda Downloads</td>
<td>
<a href="https://anaconda.org/slacgismo/solar-data-tools">
<img src="https://anaconda.org/slacgismo/solar-data-tools/badges/downloads.svg" alt="conda-forge downloads" />
<a href="https://anaconda.org/conda-forge/solar-data-tools">
<img src="https://anaconda.org/conda-forge/solar-data-tools/badges/downloads.svg" alt="conda-forge downloads" />
</a>
</td>
</tr>
Expand Down Expand Up @@ -126,12 +126,15 @@ $ pip install "solar-data-tools[mosek]"
#### Install with conda

>[!WARNING]
> When installing solar-data-tools using conda, you will need to add three channels, conda-forge, slacgismo, and stanfordcvxgrp, to your conda config (or alternatively specify them using the `-c` flag as shown in the examples below). Failure to do so will result in the installation of an outdated solar-data-tools version. Note that we will be moving solar-data-tools to conda-forge soon, which will simplify the installation process. Check back soon for an update! For more on conda channels, see the [conda docs](https://conda.io/projects/conda/en/latest/user-guide/tasks/manage-channels.html).
> `solar-data-tools` is now available on conda-forge! You can specify
> the channel using the `-c` flag as shown in the examples below.
> The use of the slacgismo channel is **deprecated** and packages
> on that channel will **not** be up-to-date with the latest releases.

Creating the environment and directly installing the package and its dependencies from the appropriate conda channels:

```bash
$ conda create -n pvi-user solar-data-tools -c conda-forge -c slacgismo -c stanfordcvxgrp
$ conda create -n pvi-user solar-data-tools -c conda-forge
```

Starting the environment:
Expand All @@ -149,7 +152,7 @@ $ conda deactivate
Or alternatively install the package in an already existing environment:

```bash
$ conda install solar-data-tools -c conda-forge -c slacgismo -c stanfordcvxgrp
$ conda install solar-data-tools -c conda-forge
```

### Solvers
Expand Down
16 changes: 6 additions & 10 deletions docs/source/getting_started/install.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,20 +17,16 @@ $ pip install "solar-data-tools[mosek]"
## Install with conda

```{warning}
When installing solar-data-tools using conda, you will need to add three channels,
conda-forge, slacgismo, and stanfordcvxgrp, to your conda config (or alternatively
specify them using the `-c` flag as shown in the examples below). Failure to do so will
result in the installation of an outdated solar-data-tools version. Note that we will be
moving solar-data-tools to conda-forge soon, which will simplify the installation process.
Check back soon for an update! For more on conda channels, see the
[conda docs](https://conda.io/projects/conda/en/latest/user-guide/tasks/manage-channels.html).
`solar-data-tools` is now available on conda-forge! You can specify
the channel using the `-c` flag as shown in the examples below.
The use of the slacgismo channel is **deprecated** and packages
on that channel will **not** be up-to-date with the latest releases.
```

Creating the environment and directly installing the package and its dependencies from the appropriate conda channels:

```bash
$ conda create -n pvi-user solar-data-tools -c conda-forge -c slacgismo -c stanfordcvxgrp
```
$ conda create -n pvi-user solar-data-tools -c conda-forge

Starting the environment:

Expand All @@ -47,7 +43,7 @@ $ conda deactivate
Or alternatively install the package in an already existing environment:

```bash
$ conda install solar-data-tools -c conda-forge -c slacgismo -c stanfordcvxgrp
$ conda install solar-data-tools -c conda-forge
```

# Solvers
Expand Down
8 changes: 4 additions & 4 deletions docs/source/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,15 +7,15 @@
:width: 600
:class: only-light
:align: center

https://github.com/enterprises/slacstanford
Welcome to the Solar Data Tools Docs!
=====================================
|PyPI release| |Anaconda Cloud release|
|PyPI release| |Conda-forge release|

.. |PyPI release| image:: https://img.shields.io/pypi/v/solar-data-tools.svg
:target: https://pypi.org/project/solar-data-tools/
.. |Anaconda Cloud release| image:: https://anaconda.org/slacgismo/solar-data-tools/badges/version.svg
:target: https://anaconda.org/slacgismo/solar-data-tools
.. |Conda-forge| image:: https://anaconda.org/conda-forge/solar-data-tools/badges/version.svg
:target: https://anaconda.org/conda-forge/solar-data-tools

Solar Data Tools is an open-source Python library for analyzing PV power (and irradiance) time-series data.
It was developed to enable analysis of unlabeled PV data, i.e. with no model, no meteorological data, and no performance
Expand Down