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.

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

More general updates #367

Merged
merged 13 commits into from
May 8, 2024
Merged

More general updates #367

merged 13 commits into from
May 8, 2024

Conversation

abachma2
Copy link
Member

This PR addresses some of the issues raised in #337, specifically:

  • some of the build warnings from source/cep/cep27.rst
  • adding a news item
  • adding a missing version release for v1.5.5.
  • fixing typos/small issues identified by @dean-krueger
  • removing the data_explorer.rst from the user tutorial
  • removing mention of cloud for running cyclus from user tutorial.

The data_explorer page was missing figures, and used
an `analysi` package that is not available through Cyclus.
Use of this page was replaced with pointing to the Cymetric
github for analysis and examples
@@ -0,0 +1,57 @@
.. _1.5.5:

Copy link
Contributor

Choose a reason for hiding this comment

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

In our meeting on Monday we discussed modifying the "Cyclus Previous Versions" page to simply reference the GitHub releases. The releases already have the changes in the descriptions so it probably isn't necessary to copy/paste that information into the site as well. Do you have any thoughts about this?

Copy link
Member Author

Choose a reason for hiding this comment

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

So something like pointing to this page for the 1.5.5 release? Instead of having separate web pages for the releases?

Copy link
Contributor

@bennibbelink bennibbelink May 6, 2024

Choose a reason for hiding this comment

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

Not sure if we even need to link each release... we could say that all the releases can be found at this page so we don't need to manually copy/paste info from Github to the site with each release. I might have misunderstood the group consensus though - @gonuke what did you have in mind?

EDIT: Thats exactly what you did sorry :) I should've looked closer at your changes before commenting

@abachma2 abachma2 marked this pull request as ready for review May 6, 2024 21:27
@abachma2 abachma2 self-assigned this May 6, 2024
@bennibbelink
Copy link
Contributor

Not sure if you saw my PR to your branch. This small change could be thrown into this PR.

Release notes and changelogs for previous versions of |Cyclus| are
available through the `project GitHub <https://github.com/cyclus/cyclus/releases>`_.
These pages also contain zips for the source code of each version. These zip
packages are also available below.
Copy link
Contributor

Choose a reason for hiding this comment

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

Do we need to maintain this table of zips/tarballs still?

Copy link
Member

Choose a reason for hiding this comment

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

While I agree that it would be great to avoid maintaining the table, it's nice to get a compact view of releases/release dates.... wonder if can automate that in a future update (i.e. make an issue)

Copy link
Member Author

Choose a reason for hiding this comment

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

All of the zips are on the github tags page. Maybe link to those?


.. _NEUP: http://www.neup.gov

.. _MARKAL: http://www.iea-etsap.org/web/Markal.asp
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
.. _MARKAL: http://www.iea-etsap.org/web/Markal.asp


.. _MARKAL: http://www.iea-etsap.org/web/Markal.asp

.. _GCAM: http://www.globalchange.umd.edu/models/gcam/
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
.. _GCAM: http://www.globalchange.umd.edu/models/gcam/

@@ -30,7 +30,6 @@ Exercise #1
add_commod_recipe
add_proto
add_reg_inst
launch_cyclus
Copy link
Contributor

Choose a reason for hiding this comment

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

I see this removes "Using Cyclus in the Cloud". There is another reference to the cloud service in user/tutorial/install_launch_cyclus that should probably also be removed.

Copy link
Member Author

Choose a reason for hiding this comment

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

I'll make sure that gets removed. This cloud service isn't working, so we shouldn't get users' hopes up that they don't have to install locally.

Copy link
Member

@gonuke gonuke left a comment

Choose a reason for hiding this comment

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

Not sure why we're deleting the data explorer page?

Copy link
Member

Choose a reason for hiding this comment

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

Why are we getting rid of this?

Copy link
Member Author

Choose a reason for hiding this comment

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

  1. It's not actually called anywhere, like no other page links to it
  2. It uses a python package (analaysis.py) that I don't know where people are supposed to get access to it.
  3. We link to the Cymetric GitHub in one of the pages for how to use that tool for analysis
  4. We are missing a bunch of figures that are supposed to go on this page, and I think it would be nontrivial to recreate them, especially since I don't have the analysis.py to replicate the procedure.

Copy link
Member

Choose a reason for hiding this comment

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

Thanks, I it didn't appear to be so immediately out of date on my scan during review, but that all makes sense.

Copy link
Member Author

Choose a reason for hiding this comment

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

Fair question. And I think I included some of this information in the commit message when I deleted it, so hopefully it helps to answer future questions.

@abachma2
Copy link
Member Author

abachma2 commented May 7, 2024

One note about removing the release notes from the website: Some of the Release notes with the tags on GitHub point to those pages (like v1.3). Should we just copy the contents of the web pages to these notes? To make sure we don't lose anything and it's all in the same place?

@abachma2 abachma2 requested review from gonuke and bennibbelink May 7, 2024 13:41
@gonuke
Copy link
Member

gonuke commented May 8, 2024

One note about removing the release notes from the website: Some of the Release notes with the tags on GitHub point to those pages (like v1.3). Should we just copy the contents of the web pages to these notes? To make sure we don't lose anything and it's all in the same place?

It looks like v1.3 may have been the only one and I just copy/pasted the content to the release info on each of Cyclus/Cycamore/Cymetric

@bennibbelink bennibbelink merged commit a33ddfd into cyclus:source May 8, 2024
2 checks passed
@bennibbelink bennibbelink mentioned this pull request Aug 9, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Development

Successfully merging this pull request may close these issues.

3 participants