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

Create webpage for simulation #25

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

forsyth2
Copy link
Collaborator

Create a webpage for a simulation automatically as part of post.py. Resolves #24.

@forsyth2 forsyth2 added semver: new feature New feature (will increment minor version) priority: low Low priority task labels Apr 21, 2021
@forsyth2 forsyth2 self-assigned this Apr 21, 2021
@@ -79,3 +80,32 @@
# mpas_analysis tasks
mpas_analysis(config, scriptDir)

# Create page for the simulation
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Might be useful to add variables for generate_global_time_series_plots.sh to the configuration file, so it can be run automatically from post.py. Then we can also find the global time series link to display.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

See #26 for the global time series plot generation

post.py Show resolved Hide resolved
for page in pages:
print(page)

# TODO: create a nice webpage (using Pandoc?) rather than just printing links
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Could use pandoc (https://pandoc.org/index.html)

@sarats
Copy link
Member

sarats commented Apr 24, 2021

@chengzhuzhang I would like to discuss sometime if PACE integration can help in this regard.

@chengzhuzhang
Copy link
Collaborator

@sarats Thank you for following this! I understand this issue particularly targets automatically creating webpages including analysis results. Integration with PACE will enable inclusion of performance and run es3m info. That would be really nice, and could be a final goal. Happy to talk more on this.

@xylar
Copy link
Contributor

xylar commented Oct 7, 2021

I think an eventual goal for zppy could also be presenting a coherent web design that then maybe could be adopted by the underlying tools. It's a little frustrating that e3sm_diags and MPAS-Analysis have such different looks and feels to our web pages. It would be nice to unify things but I also don't get then sense that either of us wants to change. Maybe zppy presents an opportunity to design a way forward that we can all adopt? Not this PR, but future work...

@golaz
Copy link
Collaborator

golaz commented Oct 9, 2021

My goal for zppy has always been to free model runners from all the tedious tasks that come along with running, analyzing, documenting simulations. I think we have made great progress, but we still a number of tedious tasks.

One of them is creating a Confluence page documenting the simulation: listing all the simulation details, jobs and creating links to all the analysis figures. So I like the idea of a more coherent web design. In addition to being more aesthetically pleasing, it could also alleviate some manual labor.

@wlin7 has also developed a very nice integrated viewer for E3SM Diags that allows for easy comparison of simulations. I'd like to see it integrated somehow.

Lots of ideas we could consider, but we should proceed carefully and thoughtfully. I don't want zppy to become overly complicated or rigid.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
priority: low Low priority task semver: new feature New feature (will increment minor version)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Automatically create information page for simulation
5 participants