Metadata-Version: 2.1
Name: astroedu
Version: 0.2.0a1
Summary: A python package for astronomy educators
Home-page: https://github.com/astroDimitrios/astroedu
Author: Dimitrios Theodorakis
Author-email: astrodimitrios@gmail.com
License: UNKNOWN
Project-URL: Bug Tracker, https://github.com/astroDimitrios/astroedu/issues
Description: <center>
            <img width="100%" src="https://raw.githubusercontent.com/astroDimitrios/astroedu/e2d3007b867c3f5ac34d6bf4b2ca2f02aa38d824/assets/logo/astroeduLOGOtag.svg" alt='AP Logo'>
        </center>
        
        [![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.0-4baaaa.svg)](code_of_conduct.md) 
        
        This package is in alpha.
        
        ## Installation
        
        To install **astroedu** run
        ```
        >>> pip install astroedu
        ```
        then run
        ```
        >>> astroedu build
        ```
        which creates the configuration file **config.ini**.
        
        **config.ini** stores the location of your documents folder.
        This is where an astroedu folder for interactive activites will me made. (not yet implemented)
        
        ## Current Functionality
        
        ### Interactives
        
        ```
        >>> astroedu interactive wiens_law
        ```
        
        Loads the interactive notebook file exploring Wien's Law. 
        Jupyter lab arguments can be passed after the interactive name for instance:
        
        ```
        >>> astroedu interactive wiens_law --port 9999
        ```
        
        ### Datasets
        
        To use a data set import the utitlity function ```load_data``` from the datasets module:
        ```
        from astroedu.datasets import load_data
        ```
        Then you can load a data set by passing its name as a string to ```load_data```.
        ```
        planets = load_data('planets')
        ```
        The function returns a Pandas dataframe.
        
        ### Constants
        
        Astropy like constants for ease of access.
        For full functionality use the astropy [constants](https://docs.astropy.org/en/stable/constants/) submodule.
        
        ```
        >>> from astroedu.constants import c
        >>> c
        Constant(c, 299792458, m/s, Speed of light)
        ```
        or
        ```
        >>> import astroedu.constants as const
        >>> print(const.c)
        Name = Speed of light
        Value = 299792458
        Unit = m/s
        ```
        
        Constants can perform simple maths with other constants or int/float/np.array.
        The returned value is an int/float/np.array not a Constant class instance:
        ```
        >>> from astroedu.constants import c, m_e
        >>> c*m_e
        2.7309245302881346e-22
        ```
        Caveat: Constant must be in front of the array.
        ```
        >>> import numpy as np
        >>> from astroedu.constants import c
        >>> a = np.arange(4)
        >>> c*a
        array([        0, 299792458, 599584916, 899377374])
        >>> a*c
        TypeError: unsupported operand type(s) for *: 'int' and 'Constant'
        ```
Keywords: astronomy education astrophysics
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Operating System :: OS Independent
Requires-Python: >=3.7
Description-Content-Type: text/markdown
