Skip to content

PySAM Doc revisions for PySAM version 8.0.0 - #229

Merged
cpaulgilman merged 17 commits into
mainfrom
pysam-doc-test
Aug 31, 2026
Merged

PySAM Doc revisions for PySAM version 8.0.0#229
cpaulgilman merged 17 commits into
mainfrom
pysam-doc-test

Conversation

@cpaulgilman

Copy link
Copy Markdown
Collaborator

Adds version descriptions for PySAM 7.1.1 and PySAM 8.0.0.

Description of new Pvsamv1 Tools.

NREL to NLR.

Add installation instructions for Anaconda.

Add instructions for version comparison to readme.

Remove pyssc-for-dao-tk.

@cpaulgilman
cpaulgilman requested review from brtietz and sjanzou August 24, 2026 23:15
@cpaulgilman cpaulgilman self-assigned this Aug 24, 2026
Comment thread docs/versions.rst
For a list of PySAM versions and their equivalent SAM and SSC versions, see https://github.com/natlabrockies/pysam/releases.

.. note:: PySAM 8.0.0 and newer are available as nlr-pysam. Older versions are available as nrel-pysam. PySAM 8.0.0 is available both as nlr-pysam and nrel-pysam.
For a list of versions available on PyPI, see https://pypi.org/project/NLR-PySAM/. For versions available on Anaconda, see https://anaconda.org/channels/nrel/packages/nrel-pysam/overview.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Will nlr-pysam get posted to conda? (link still points to nrel-pysam)

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

Will nlr-pysam get posted to conda? (link still points to nrel-pysam)

There isn't an NLR channel on Anaconda.org yet that I can see. There are a handful of packages on the NREL channel, including PySAM: https://anaconda.org/channels/nrel. This is something we can update in the PySAM documentation when the Anacona.org updates are completed.

Comment thread PySAM/version_differ.py Outdated
" 3. Modified Variables: New variables, Removed variables and Type-changed variables\n" \
" 4. Modified Default Values"

"PySAM " + __version__ + " was released April 28, 2026 and corresponds to SAM 2025.4.16 Revision 2, SSC Version 306.\n\n"\

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Should this be updated for 2026.7.3?

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

Should this be updated for 2026.7.3?

Done in 1de4716. I'll update instructions to explain how version_differ.lk works and when to run it.

Comment thread pyproject.toml Outdated

[project.urls]
Documentation = "https://nlr-pysam.readthedocs.io"
Documentation = "https://nrel-pysam.readthedocs.io"

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Is this set up for the final version of nrel-pysam?

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

Fixed in 9dd46be

@brtietz brtietz left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Looks good overall. A few minor questions on nrel vs nlr and version numbers.

@sjanzou sjanzou left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Looks good and will need to update when nlr-conda is updated.

I am working on the Windows pull request here - not sure why failing yet...

Comment thread docs/installation.rst

.. code:: bash

conda install nrel::nrel-pysam

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Note that conda only currently has 7.1.1 as latest

@sjanzou

sjanzou commented Aug 31, 2026

Copy link
Copy Markdown
Collaborator

Latest commit fixes Windows runner on pull request.
This pull request looks good and will need updating after conda nlr-pysam is posted

@cpaulgilman
cpaulgilman merged commit 21e0433 into main Aug 31, 2026
6 checks passed
@cpaulgilman
cpaulgilman deleted the pysam-doc-test branch August 31, 2026 15:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants