Metadata-Version: 1.1
Name: OASYS1-ESRF-Extensions
Version: 0.0.20
Summary: OASYS extension for the ESRF
Home-page: https://github.com/oasys-esrf-kit/OASYS1-ESRF-Extensions
Author: Luca Rebuffi, Manuel Sanchez del Rio
Author-email: lrebuffi@anl.gov, srio@serf.eu
License: GPLv3
Download-URL: https://github.com/oasys-esrf-kit/OASYS1-ESRF-Extensions
Description: # OASYS1-ESRF-Extensions
        OASYS extensions for the ESRF
        
        This repository contains extensions to Oasys developed at ESRF. 
        
        ## Install as user
        
        To install the add-on as user: 
        
        + In the Oasys window, open "Options->Add-ons..."
        + click the button "Add more" and enter "OASYS1-ESRF-Extensions". You will see a new entry "ESRFExtensions" in the add-on list. Check it and click "OK"
        + Restart Oasys.
        
        ![addon menu](https://github.com/oasys-esrf-kit/OASYS1-ESRF-Extensions/blob/master/images/image2.png "addon menu")
        
        Once it is installed, it should populate the widget bar on the side.
        
        ![side menu](https://github.com/oasys-esrf-kit/OASYS1-ESRF-Extensions/blob/master/images/image1.png "side menu")
        
        ## Install as developper
        
        To install it as developper, download it from github:
        ```
        git clone  https://github.com/oasys-esrf-kit/OASYS1-ESRF-Extensions
        cd OASYS1-ESRF-Extensions
        ```
        
        Then link the source code to your Oasys python (note that you must use the python that Oasys uses):  
        ```
        python -m pip install -e . --no-deps --no-binary :all:
        ```
        
        When restarting Oasys, you will see the ESRF addons there.
        
        ## Upload new version to the pypi server
        
        First create a new version using your developper installation. Do not forget to increment the version number in setup.py
        
        + Then run:
        
        ```
        python setup.py sdist
        ```
        
        + Followed by:
        
        ```
        python -m twine upload dist/OASYS1-ESRF-Extensions-X.X.X.tar.gz
        ```
        
        You need an account in pypi.org and be authorized in https://pypi.org/project/OASYS1-ESRF-Extensions/
        
Keywords: raytracing,simulator,oasys1
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: X11 Applications :: Qt
Classifier: Environment :: Console
Classifier: Environment :: Plugins
Classifier: Programming Language :: Python :: 3
Classifier: Intended Audience :: Science/Research
