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

Updating the front-facing README #11

Open
jlmaurer opened this issue Feb 3, 2021 · 5 comments
Open

Updating the front-facing README #11

jlmaurer opened this issue Feb 3, 2021 · 5 comments

Comments

@jlmaurer
Copy link
Collaborator

jlmaurer commented Feb 3, 2021

  • @dbekaert I've updated the documention on using RAiDER. Most of the material on the front-page readme is now not needed, as that is included in the "Getting Started ..." notebook.
  • We may want to move the installation info from the Getting Started notebook to the main README, or even put it in both places. The nice thing about the notebook is that right now it takes the user through the complete process of getting started, so could be used in a workshop etc.
  • Also may want to move the info on accessing weather model data to it's own README or notebook, or perhaps it is fine here.
  • There may need to be some additional details worked out in the Getting Started notebook.
  • I put a triple-star (***) anywhere I need to fill in more details or check a statement.
@jlmaurer
Copy link
Collaborator Author

@dbekaert #13 addressed a bunch of what we discussed, still some things to add / fill in

@dbekaert
Copy link
Owner

Hi @jlmaurer, great thanks for making the changes. This looks a lot cleaner already.

wrt to the "Running raider" notebook:

Would recommend changing it to raiderDelay.ipyn to keep track of the program names and the notebooks.

Remove the example of running raider with the figures on how it looks like for pressure temperature etc into the "adding a new model" notebook. You could talk to it briefly if you like, but main focus is for raiderDelay notebook to use real examples on how to calculate delays using the options described using the -h help arguments.

i.e. computation of zenith delay at GNSS nodes
i.e. computation of slant delays at weather model nodes using an orbit file
i.e. computation of slant delays for a small IFG, perhaps take the IFG over hawaii from ARIA GUNW where there is a correction that makes sense.

wrt to "add a new model to Raider notebook"

Would move the example of running raider notebook with the figures on how it looks like for pressure temperature etc into the "adding a new model" notebook. That is really information to validate that a new model was added correctly.

@dbekaert
Copy link
Owner

The defining "Defining Custom Weather Models" is really "account for weather model downloads".
The notebook looks great. Plan to move it to the Raider main page, will make a copy from this one.
The installation on i think we got that covered. We might want to add a separate how to install not using conda and make sure we copy some of the information that is missing. As you suggest we can keep it till we make the change.

@dbekaert
Copy link
Owner

@jlmaurer I worked off you PR and updated the installation .md page on the Raider repo. For the main landing readme.md page we just need to clean it up a bit.

  • Table of contents does not match the subsequent headers, needs to match 1-1 for clarify.
  • Would avoid linking from main page to another page in TOC alone. Would also make a corresponding header with description an reference there too.
  • We should limit duplication as that requires us to update at multiple locations
    • An option would be to to move the installation guidelines into the landing page direclty.
    • An option would be to reference to account set-up int he landing page
  • There are more headers then there are in the TOC.
  • hyperlinks needs to be done correctly or the will not work: see here for details https://github.com/ekalinin/github-markdown-toc

@jlmaurer
Copy link
Collaborator Author

jlmaurer commented Feb 23, 2021

Just updating the list of To-Dos:

  • Add small lat/lon raster example to RAiDER tutorial
  • Go through all the notebooks and bomb-proof
  • Verify which weather model can be run without problems
  • Verify that all the notebooks look consistent

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

No branches or pull requests

2 participants