Metadata-Version: 2.4
Name: roman-technical-information
Version: 1.5.0
Summary: Roman Space Telescope technical information (YAML/ECSV data and helpers).
Author: Roman Project Science Team
License: 
        This work is marked with CC0 1.0 Universal. To view a copy of this license, visit https://creativecommons.org/publicdomain/zero/1.0/
        
        
        
        Creative Commons Legal Code
        
        CC0 1.0 Universal
        
            CREATIVE COMMONS CORPORATION IS NOT A LAW FIRM AND DOES NOT PROVIDE
            LEGAL SERVICES. DISTRIBUTION OF THIS DOCUMENT DOES NOT CREATE AN
            ATTORNEY-CLIENT RELATIONSHIP. CREATIVE COMMONS PROVIDES THIS
            INFORMATION ON AN "AS-IS" BASIS. CREATIVE COMMONS MAKES NO WARRANTIES
            REGARDING THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS
            PROVIDED HEREUNDER, AND DISCLAIMS LIABILITY FOR DAMAGES RESULTING FROM
            THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS PROVIDED
            HEREUNDER.
        
        Statement of Purpose
        
        The laws of most jurisdictions throughout the world automatically confer
        exclusive Copyright and Related Rights (defined below) upon the creator
        and subsequent owner(s) (each and all, an "owner") of an original work of
        authorship and/or a database (each, a "Work").
        
        Certain owners wish to permanently relinquish those rights to a Work for
        the purpose of contributing to a commons of creative, cultural and
        scientific works ("Commons") that the public can reliably and without fear
        of later claims of infringement build upon, modify, incorporate in other
        works, reuse and redistribute as freely as possible in any form whatsoever
        and for any purposes, including without limitation commercial purposes.
        These owners may contribute to the Commons to promote the ideal of a free
        culture and the further production of creative, cultural and scientific
        works, or to gain reputation or greater distribution for their Work in
        part through the use and efforts of others.
        
        For these and/or other purposes and motivations, and without any
        expectation of additional consideration or compensation, the person
        associating CC0 with a Work (the "Affirmer"), to the extent that he or she
        is an owner of Copyright and Related Rights in the Work, voluntarily
        elects to apply CC0 to the Work and publicly distribute the Work under its
        terms, with knowledge of his or her Copyright and Related Rights in the
        Work and the meaning and intended legal effect of CC0 on those rights.
        
        1. Copyright and Related Rights. A Work made available under CC0 may be
        protected by copyright and related or neighboring rights ("Copyright and
        Related Rights"). Copyright and Related Rights include, but are not
        limited to, the following:
        
          i. the right to reproduce, adapt, distribute, perform, display,
             communicate, and translate a Work;
         ii. moral rights retained by the original author(s) and/or performer(s);
        iii. publicity and privacy rights pertaining to a person's image or
             likeness depicted in a Work;
         iv. rights protecting against unfair competition in regards to a Work,
             subject to the limitations in paragraph 4(a), below;
          v. rights protecting the extraction, dissemination, use and reuse of data
             in a Work;
         vi. database rights (such as those arising under Directive 96/9/EC of the
             European Parliament and of the Council of 11 March 1996 on the legal
             protection of databases, and under any national implementation
             thereof, including any amended or successor version of such
             directive); and
        vii. other similar, equivalent or corresponding rights throughout the
             world based on applicable law or treaty, and any national
             implementations thereof.
        
        2. Waiver. To the greatest extent permitted by, but not in contravention
        of, applicable law, Affirmer hereby overtly, fully, permanently,
        irrevocably and unconditionally waives, abandons, and surrenders all of
        Affirmer's Copyright and Related Rights and associated claims and causes
        of action, whether now known or unknown (including existing as well as
        future claims and causes of action), in the Work (i) in all territories
        worldwide, (ii) for the maximum duration provided by applicable law or
        treaty (including future time extensions), (iii) in any current or future
        medium and for any number of copies, and (iv) for any purpose whatsoever,
        including without limitation commercial, advertising or promotional
        purposes (the "Waiver"). Affirmer makes the Waiver for the benefit of each
        member of the public at large and to the detriment of Affirmer's heirs and
        successors, fully intending that such Waiver shall not be subject to
        revocation, rescission, cancellation, termination, or any other legal or
        equitable action to disrupt the quiet enjoyment of the Work by the public
        as contemplated by Affirmer's express Statement of Purpose.
        
        3. Public License Fallback. Should any part of the Waiver for any reason
        be judged legally invalid or ineffective under applicable law, then the
        Waiver shall be preserved to the maximum extent permitted taking into
        account Affirmer's express Statement of Purpose. In addition, to the
        extent the Waiver is so judged Affirmer hereby grants to each affected
        person a royalty-free, non transferable, non sublicensable, non exclusive,
        irrevocable and unconditional license to exercise Affirmer's Copyright and
        Related Rights in the Work (i) in all territories worldwide, (ii) for the
        maximum duration provided by applicable law or treaty (including future
        time extensions), (iii) in any current or future medium and for any number
        of copies, and (iv) for any purpose whatsoever, including without
        limitation commercial, advertising or promotional purposes (the
        "License"). The License shall be deemed effective as of the date CC0 was
        applied by Affirmer to the Work. Should any part of the License for any
        reason be judged legally invalid or ineffective under applicable law, such
        partial invalidity or ineffectiveness shall not invalidate the remainder
        of the License, and in such case Affirmer hereby affirms that he or she
        will not (i) exercise any of his or her remaining Copyright and Related
        Rights in the Work or (ii) assert any associated claims and causes of
        action with respect to the Work, in either case contrary to Affirmer's
        express Statement of Purpose.
        
        4. Limitations and Disclaimers.
        
         a. No trademark or patent rights held by Affirmer are waived, abandoned,
            surrendered, licensed or otherwise affected by this document.
         b. Affirmer offers the Work as-is and makes no representations or
            warranties of any kind concerning the Work, express, implied,
            statutory or otherwise, including without limitation warranties of
            title, merchantability, fitness for a particular purpose, non
            infringement, or the absence of latent or other defects, accuracy, or
            the present or absence of errors, whether or not discoverable, all to
            the greatest extent permissible under applicable law.
         c. Affirmer disclaims responsibility for clearing rights of other persons
            that may apply to the Work or any use thereof, including without
            limitation any person's Copyright and Related Rights in the Work.
            Further, Affirmer disclaims responsibility for obtaining any necessary
            consents, permissions or other rights required for any use of the
            Work.
         d. Affirmer understands and acknowledges that Creative Commons is not a
            party to this document and has no duty or obligation with respect to
            this CC0 or use of the Work.
Project-URL: Homepage, https://github.com/RomanSpaceTelescope/roman-technical-information
Project-URL: Source, https://github.com/RomanSpaceTelescope/roman-technical-information
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE.md
Requires-Dist: pyyaml
Requires-Dist: astropy
Dynamic: license-file

# Roman Space Telescope Technical Information

This repository hosts technical information related to the Nancy Grace Roman Space Telescope (Roman), its Wide Field Instrument (WFI), and its Coronagraph technology demonstration (Coronagraph). This repository is open to everyone, and the information contained within is public without any restrictions. The intended audience for this information is primarily the:
* Roman Science Operations Center (SOC) at the Space Telescope Science Institute (STScI)
* Roman Science Support Center (SSC) at the Infrared Processing and Analysis Center (IPAC)
* Project Infrastructure and Wide Field Science Teams
* Committees performing definition of the community survey programs
* Roman user community

# Installing this Repository

This repo can be easily installed via pip:
```
pip install "git+https://github.com/RomanSpaceTelescope/roman-technical-information.git"
```

You can then check that the code has installed properly by typing the following commands in Python:

```
import roman_technical_information
from roman_technical_information import io

print(io.load_yaml(
    "Observatory/MissionandObservatoryTechnicalOverview/MissionandObservatory.yaml"
).keys())
```


# Using this Repository

The information in this respository is tagged for releases. We encourage users to use the released versions to better communicate the version of the information used, particularly as some items are updated frequently.

Within the data/ directory, information related to the spacecraft, the WFI, and the Coronagraph are broken out into separate subdirectories. Each folder contains a README.md file that describes the information contained within as well as giving the update history for the information.

**Note:** Most files here are either in a .yaml or .ecsv format. Either can be easily read in with Python3.

## YAML Files 
YAML file can be read in with the [pyyaml packge](https://pyyaml.org). For more details, please see the [pyyaml documentation](https://pyyaml.org/wiki/PyYAMLDocumentation).
For example, here's how to read in the yaml file `MissionandObservatory.yaml` located in `roman-technical-information/data/Observatory/MissionandObservatoryTechnicalOverview/`:
```
# import the yaml package (installed via the pyyaml package)
import yaml

# read in the file
with open('MissionandObservatory.yaml', 'r') as file:
    # the data will be stored as the Python dictionary "Roman"
    Roman = yaml.safe_load(file)
    
# Roman is a Python dictionary
print(Roman)
print(Roman.keys())
print(Roman['Mission_and_Spacecraft_Parameters'])
print(Roman['Mission_and_Spacecraft_Parameters']['orbit'])
```

## ECSV (Enhanced Character-Separated Values) Files 
ECSV files can be read in with the [astropy package](https://www.astropy.org). For more details, please see [astropy's ecsv documentation](https://docs.astropy.org/en/stable/io/ascii/ecsv.html) and the [astropy example on reading Gaia ecsv files](https://docs.astropy.org/en/stable/io/ascii/read.html#reading-gaia-data-tables).
For example, here's how to read in the ecsv file `nominal_roll_angles_dec_1_observatory.ecsv` located in `roman-technical-information/data/Observatory/RollAngles/`: 
```
# You can use either Table or QTable, both of which are part of the astropy package
from astropy.table import Table
from astropy.table import QTable

# Read in the ecsv file
Roman = Table.read("nominal_roll_angles_dec_1_observatory.ecsv",format="ascii.ecsv")

# "Roman" is now an astropy data table (https://docs.astropy.org/en/stable/table/)
type(Roman)
dir(Roman)
print(Roman.keys())
print(Roman['Month'])
print(Roman['RA_sun'].unit)

# You can alternatively use QTable instead
Roman = QTable.read("nominal_roll_angles_dec_1_observatory.ecsv",format="ascii.ecsv")
```

# Versioning
You can find the version number in VERSION.md.

The Roman Technical Information repo uses the following version number convention:

MAJOR.MINOR.PATCH

Where MAJOR is a major code change (such as the introduction of a many new parameters), MINOR is a minor code change (such as the introduction of a new table), and PATCH is a small patch/bugfix (e.g., fixing a typo). See [Semantic Versioning](https://semver.org) for more details.

# Contributions and Feedback

Please see our [contributing instructions](CONTRIBUTING.md) for more information.

Most importantly, if you are in need of information that is not listed here or that you suspect is out of date, please open an issue and someone will get back to you as soon as possible.

# Code of Conduct

This repository follows the Spacetelescope organization [Code of Conduct](CODE_OF_CONDUCT.md) to provide a welcoming community to all of our users and contributors.

# Documentation and Help

For more information related to the Roman mission, please see the following resources:
* [Roman mission website at Goddard Space Flight Center (GSFC)](https://roman.gsfc.nasa.gov/)
* [The Roman Documentation System (RDox) at STScI](https://roman-docs.stsci.edu/)

More links will be added as the become available.

For help with understanding or using the information in this repository, you can contact the [Roman Space Telescope Help Desk](https://stsci.service-now.com/roman).
