search

abuonomo / paper-data-links

heliophysics query scripts
MIT License
1 stars 1 forks source link

create a README for every paper. #81

Open abuonomo opened 3 months ago

abuonomo commented 3 months ago

Need README landing pages for ADS to link to.

Example README in comment below:

abuonomo commented 3 months ago

Bibcode: 2022ApJ...927..100S

Solar Dynamics and Magnetic Field Evolution

Authors: A. Solar, B. Dynamics, C. Evolution

Overview

This repository contains files that have been generated to aid in the understanding and analysis of the paper. The download script included here is specifically designed to retrieve data from the Virtual Solar Observatory (VSO).

VSO Instruments Used

Usage

  1. Download Script: Run the download_script.py to fetch data related to the paper. Ensure you have all the necessary dependencies, including SunPy, installed. This script is designed to retrieve data specifically from the VSO. Please note that this script represents a starting point and may not be 100% perfect. Users are encouraged to review and modify it as needed.
  2. Instrument Information: Check INSTRUMENT_DETAILS.md for comprehensive information on the instruments used. This can provide context and help in understanding the data fetched by the script.

Contributions and Contact

For any further details or contributions, please refer to our Contributing Guide.

If you encounter any problems or have suggestions for improvements, please submit an issue or make a pull request to correct anything you think is wrong.