Metadata-Version: 2.1
Name: NatPy
Version: 0.0.3
Summary: Convert the units of particle physics quantities.
Home-page: https://github.com/AndreScaffidi/NatPy
Author: Tomas Howson and Andre Scaffidi
Author-email: tomas.howson@adelaide.edu.au, andre.scaffidi@adelaide.edu.au
License: UNKNOWN
Description: # NatPy
        ## Convert the units of particle physics quantities
        ---
        ### Packages needed:
        - astropy
        - numpy
        ---
        ### Basic Usage
        
        Code levarages `astropy.units.core.Unit` and `astropy.units.quantity.Quantity` objects.
         
        1. Run `import natpy`.
        2. Access physical constants with symbol:
        ```
        >>> natpy.const.c
        <class 'astropy.constants.codata2018.CODATA2018'> name='Speed of light in vacuum' value=299792458.0 uncertainty=0.0 unit='m / s' reference='CODATA 2018'>
        
        
        >>> natpy.const.hbar
        <class 'astropy.constants.codata2018.CODATA2018'> name='Reduced Planck constant' value=1.0545718176461565e-34 uncertainty=0.0 unit='J s' reference='CODATA 2018'>
        
        ```
        
        3. Specify base of natural units with `natpy.set_active_units()`. Pass a string corresponding to a list of default natural units, or a list of physical constants to set your own. List of default bases found in `natpy/default_values.py`. 
        
        4. Run `natpy.convert()` to convert between units, including necessary factors of natural units. Pass just unit objects to obtain conversion factors. Pass quantity objects to perform conversions. E.g.
        ```
        # kg to keV
        >>> natpy.convert(u.kg, u.keV)
        5.6173581670146864e+32
        
        # Electron mass
        >>> me = natpy.convert(9.11e-31 * u.kg, u.keV)
        >>> me
        <Quantity 511.74132902 keV>
        
        # Energy of electron with momentum of 1 MeV 
        >>> p = 1 * u.MeV
        >>> E = np.sqrt(p**2 + me**2)
        
        # Convert to SI units
        >>> natpy.convert(E,u.J)
        <Quantity 1.79926309e-13 J>
        ```
        Note: Summing quanties requires conventionally equivalent units.
        
        6. See ```tests/convert_test.py ``` for more examples.
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.7
Description-Content-Type: text/markdown
