Metadata-Version: 2.1
Name: NREL-phygnn
Version: 0.0.0
Summary: Physics-Guided Neural Networks (phygnn)
Home-page: https://github.com/NREL/phygnn
Author: Grant Buster
Author-email: grant.buster@nrel.gov
License: BSD 3-Clause
Description: ******
        PHYGNN
        ******
        
        An open source implementation of Physics-Guided Neural Networks (PHYGNN). 
        This implementation of PHYGNN augments a traditional neural network loss 
        function with a generic loss term that can be used to guide the neural 
        network to learn physical or theoretical constraints.
        
        .. inclusion-intro
        
        Installation
        ============
        
        1. Use conda (anaconda or miniconda with python 3.7) to create a phygnn environment: ``conda create --name phygnn python=3.7``
        2. Activate your new conda env: ``conda activate phygnn``
        3. Navigate to the phygnn directory that contains setup.py and run: ``pip install -e .`` (developer install) or ``pip install .`` (static install).
        4. Test your installation:
        
        	i. Start ipython and test the following import: ``from phygnn import PhysicsGuidedNeuralNetwork``
        	ii. Navigate to the tests/ directory and run the command: ``pytest``
        
Keywords: phygnn
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: BSD License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Requires-Python: >=3.7
Provides-Extra: dev
