-
Notifications
You must be signed in to change notification settings - Fork 30
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
More general updates #367
Conversation
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
source/previous/v1.5.5.rst
Outdated
@@ -0,0 +1,57 @@ | |||
.. _1.5.5: | |||
|
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
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
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. |
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
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)
There was a problem hiding this comment.
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?
source/news/fy24neup.rst
Outdated
|
||
.. _NEUP: http://www.neup.gov | ||
|
||
.. _MARKAL: http://www.iea-etsap.org/web/Markal.asp |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
.. _MARKAL: http://www.iea-etsap.org/web/Markal.asp |
source/news/fy24neup.rst
Outdated
|
||
.. _MARKAL: http://www.iea-etsap.org/web/Markal.asp | ||
|
||
.. _GCAM: http://www.globalchange.umd.edu/models/gcam/ |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
.. _GCAM: http://www.globalchange.umd.edu/models/gcam/ |
@@ -30,7 +30,6 @@ Exercise #1 | |||
add_commod_recipe | |||
add_proto | |||
add_reg_inst | |||
launch_cyclus |
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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.
There was a problem hiding this 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?
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
- It's not actually called anywhere, like no other page links to it
- It uses a python package (
analaysis.py
) that I don't know where people are supposed to get access to it. - We link to the Cymetric GitHub in one of the pages for how to use that tool for analysis
- 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.
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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.
Update version number in sidebar
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 |
This PR addresses some of the issues raised in #337, specifically:
source/cep/cep27.rst
data_explorer.rst
from the user tutorial