Skip to content

Commit

Permalink
updated user manual
Browse files Browse the repository at this point in the history
  • Loading branch information
kristinemlarson committed Mar 8, 2024
1 parent 18f2be2 commit bc85d54
Show file tree
Hide file tree
Showing 5 changed files with 38 additions and 19 deletions.
2 changes: 1 addition & 1 deletion docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,10 +18,10 @@ Welcome to the gnssrefl Documentation!
pages/README_install.md
pages/understand.md
pages/file_structure.md
pages/mydata.md
pages/quick_recall.md
pages/first_drivethru.md
pages/contributions_questions.md
pages/sc_index
pages/sc_index2024
pages/new_station.md
api
Expand Down
12 changes: 7 additions & 5 deletions docs/pages/contributions_questions.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# Community

## 2023 Short Course on GNSS-IR
- [overview](https://gnssrefl.readthedocs.io/en/latest/pages/sc_index.html)
- [videos/lectures](https://gnssrefl.readthedocs.io/en/latest/pages/sc_media.html)

## E-mail list
Would you like to join our <code>gnssrefl</code> users email list?
This is currently maintained by earthscope.org. To join, please e-mail
Expand All @@ -18,8 +22,7 @@ [email protected] or Kristine Larson.
python/packaging questions, improved our docker distribution, and
set up smoke tests.
- [Naoya Kadota](https://github.com/naoyakadota) added the GSI data archive and helped find a bug in nmea2snr.
- [Joakim Strandberg](https://github.com/Ydmir) provided
python RINEX translators and the EGM96 code.
- [Joakim Strandberg](https://github.com/Ydmir) provided python RINEX translators and the EGM96 code.
- Johannes Boehm provided source code for the refraction correction.
- [Makan Karegar](https://github.com/MakanAKaregar) added the NMEA capability.
- [Dave Purnell](https://github.com/purnelldj) provided his SNR inversion code.
Expand All @@ -31,9 +34,8 @@ and Simon Williams have provided significant advice for this project.
- [Dan Nowacki](https://github.com/dnowacki-usgs) added
Glonass to the NMEA reader
- [Taylor Smith](https://github.com/tasmi) has worked on the NMEA reader and the refl_zones utility.
- Surui Xie was instrumental in finding a bug in the newarcs version
- Peng Feng, Rudiger Haas, and Gunnar Elgered have helped us
improve refraction models.
- Surui Xie and Thomas Nylen were instrumental in finding a bug in the newarcs version
- Peng Feng, Rudiger Haas, and Gunnar Elgered have helped us improve refraction models.

## How you can help improve this code

Expand Down
26 changes: 26 additions & 0 deletions docs/pages/mydata.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# How do I analyze my own GNSS data?

To analyze your own GNSS data you must

- comply with the software expectations for how the files should be named.

- make sure the files have the expected information in them (e.g. SNR data, RINEX files must
have a priori coordinates in the header)

- files are stored in the expected directories.

The naming conventions for GNSS observation files are given in the
[files page](https://gnssrefl.readthedocs.io/en/latest/pages/file_structure.html).

For questions about expected folders, see
the [rinex2snr documentation](https://gnssrefl.readthedocs.io/en/latest/api/gnssrefl.rinex2snr_cl.html)

If you have questions about converting NMEA files, the best I can offer is that you read
the description in the [files page](https://gnssrefl.readthedocs.io/en/latest/pages/file_structure.html) and
possibly the [nmea2snr documentation](https://gnssrefl.readthedocs.io/en/latest/api/gnssrefl.nmea2snr_cl.html)

For docker users, there is some additional information in the [install page](https://gnssrefl.readthedocs.io/en/latest/pages/docker_cl_instructions.html).

For notebook users, you must contact Kelly Enloe at Earthscope if you have questions about how to analyze your own data.


15 changes: 2 additions & 13 deletions docs/pages/sc_index2024.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,8 @@
.. image:: ../_static/mnis_H0.png
:width: 500

Registration
============
`Course Registration <https://sfb1502.de/news-events/events/external-events/gnss-ir-2024/gnss-ir-short-course-registration>`_
Registration is Closed
======================

Agenda
======
Expand All @@ -18,16 +17,6 @@ Agenda

The course meets each day from 12:00-14:00 Central European Time.

Other Local Times

08:00-10:00 Rio de Janeiro, Buenos Aires

11:00-12:00 London, Reykjavik

14:00-16:00 Istanbul

19:00-21:00 Singapore, Wuhan

There will be a short break at the midpoint.

Before the Class Begins
Expand Down
2 changes: 2 additions & 0 deletions docs/pages/sc_media2024.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ Return to [2024 GNSS-IR Short Course](https://gnssrefl.readthedocs.io/en/latest/
- [GNSS-IR Theory](https://morefunwithgps.com/public_html/sc2024/slides-gnssir-theory-2024.pdf), Felipe Nievinski
- [How to run the gnssrefl Code](https://morefunwithgps.com/public_html/sc2024/Day1-runningCode.pdf), Kristine Larson
- [Video](https://www.youtube.com/watch?v=tkjch4QRRs8)
- [Q & A](https://morefunwithgps.com/public_html/sc2024/Day1-Q&AReport.csv)

## Day 2
- Theory for Water Levels, Simon Williams
Expand All @@ -14,5 +15,6 @@ Return to [2024 GNSS-IR Short Course](https://gnssrefl.readthedocs.io/en/latest/
- [IAG working group](https://morefunwithgps.com/public_html/sc2024/Day2-WG.pdf), Makan Karegar
- [Last Remarks](https://morefunwithgps.com/public_html/sc2024/Day2-May2024-good-bye.pdf), Kristine Larson
- [Video](https://www.youtube.com/watch?v=0Mn9z38l0fE)
- [Q & A](https://morefunwithgps.com/public_html/sc2024/Day2-Q&AReport.csv)


0 comments on commit bc85d54

Please sign in to comment.