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

Provide a walkthrough for how to format input data #144

Open
7 tasks
arbennett opened this issue Aug 29, 2018 · 0 comments
Open
7 tasks

Provide a walkthrough for how to format input data #144

arbennett opened this issue Aug 29, 2018 · 0 comments

Comments

@arbennett
Copy link
Member

arbennett commented Aug 29, 2018

After helping several other groups get up and running on MetSim I think there are several areas that the documentation is lacking in terms of onboarding users. This issue is for tracking ways that we can improve the documentation with walkthroughs, sample datasets, scripts, and other forms of help.

Documentation fixes/improvements

  • Make sure conda installation instructions are visible
  • Provide a simple page to point users to resources for getting started with python
  • Add clear links to the sample configurations and data provided in the repository

Sample data

  • Create a download link to each of the sample data sets and configurations
  • Provide a sample configuration with more options made explicit

Scripts/notebooks

  • Add some of the various notebooks for creating domain and state files
  • Write some scripts that use nco or other command line tools for building domain/state files
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant