diff --git a/README.md b/README.md index 4b9aa1e..7f26bfc 100644 --- a/README.md +++ b/README.md @@ -34,8 +34,9 @@ outlines the corrections and component calculation pipeline 3. [RV Calculations](https://github.com/tamarervin/sdo_hmi_rvs/blob/main/sdo_hmi_rvs/examples/rv_calculation.ipynb): outlines calculation of full model RV from velocity components - * requires input CSV with velocity components from [example 2](https://github.com/tamarervin/sdo_hmi_rvs/blob/main/sdo_hmi_rvs/examples/component_calculations.ipynb) - + * requires input CSV with velocity components from [example 2](https://github.com/tamarervin/sdo_hmi_rvs/blob/main/sdo_hmi_rvs/examples/component_calculations.ipynb) + * an example CSV file with calculations is stored [here](https://github.com/tamarervin/sdo_hmi_rvs/blob/main/sdo_hmi_rvs/products/csv_files/calcs/example_calcs.csv) + 4. [Full Pipeline](https://github.com/tamarervin/sdo_hmi_rvs/blob/main/sdo_hmi_rvs/examples/full_pipeline.ipynb): full end-to-end pipeline to calculate 'sun-as-a-star' RVs and magnetic observables diff --git a/mkdocs/docs/examples/docs_rv_calcs.ipynb b/mkdocs/docs/examples/docs_rv_calcs.ipynb index 4e28d61..96dd276 100644 --- a/mkdocs/docs/examples/docs_rv_calcs.ipynb +++ b/mkdocs/docs/examples/docs_rv_calcs.ipynb @@ -7,7 +7,11 @@ "\n", "1. **calculate solar velocities:** calculate solar velocities and save to csv\n", "2. **get component lists:** using pandas to get the lists of each relevant component\n", - "3. **calculate RVs and save to csv:** calculate RVs using optimized parameters" + "3. **calculate RVs and save to csv:** calculate RVs using optimized parameters\n", + "\n", + "\n", + "**NOTE:** this is purely an example but requires ground-based Solar RV\n", + "measurements for fitting" ], "metadata": { "collapsed": false diff --git a/mkdocs/docs/examples/docs_solar_corrections.ipynb b/mkdocs/docs/examples/docs_solar_corrections.ipynb index dcff774..289def0 100644 --- a/mkdocs/docs/examples/docs_solar_corrections.ipynb +++ b/mkdocs/docs/examples/docs_solar_corrections.ipynb @@ -482,7 +482,8 @@ "execution_count": null, "outputs": [], "source": [ - "map_int_cor = [sfuncs.corrected_map(Iflat[i], hmi_int[i], map_type='Corrected-Intensitygram', frame=frames.HeliographicCarrington) for i in range(0, len(hmi_int))]" + "map_int_cor = [sfuncs.corrected_map(Iflat[i], hmi_int[i], map_type='Corrected-Intensitygram',\n", + " frame=frames.HeliographicCarrington) for i in range(0, len(hmi_int))]" ], "metadata": { "collapsed": false, diff --git a/mkdocs/site/examples/docs_solar_corrections/index.html b/mkdocs/site/examples/docs_solar_corrections/index.html index 007ac5d..472498c 100644 --- a/mkdocs/site/examples/docs_solar_corrections/index.html +++ b/mkdocs/site/examples/docs_solar_corrections/index.html @@ -1692,8 +1692,8 @@

Step One: Coordinate Transformation<
@@ -1737,7 +1737,7 @@

Step One: Coordinate Transformation<