# 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.
Once it is installed, it should populate the widget bar on the side.
## 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/
Raw data
{
"_id": null,
"home_page": "https://github.com/oasys-esrf-kit/OASYS1-ESRF-Extensions",
"name": "OASYS1-ESRF-Extensions",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "raytracing, simulator, oasys1",
"author": "Manuel Sanchez del Rio, Juan Reyes-Herrera, Luca Rebuffi",
"author_email": "srio@esrf.eu",
"download_url": "https://files.pythonhosted.org/packages/39/3b/f8e96fb305c91196a45aa04fe19a8746928ec69dedfdf4a1621746686bbf/OASYS1-ESRF-Extensions-0.0.78.tar.gz",
"platform": null,
"description": "# OASYS1-ESRF-Extensions\r\nOASYS extensions for the ESRF\r\n\r\nThis repository contains extensions to Oasys developed at ESRF. \r\n\r\n## Install as user\r\n\r\nTo install the add-on as user: \r\n\r\n+ In the Oasys window, open \"Options->Add-ons...\"\r\n+ 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\"\r\n+ Restart Oasys.\r\n\r\n![addon menu](https://github.com/oasys-esrf-kit/OASYS1-ESRF-Extensions/blob/master/images/image2.png \"addon menu\")\r\n\r\nOnce it is installed, it should populate the widget bar on the side.\r\n\r\n![side menu](https://github.com/oasys-esrf-kit/OASYS1-ESRF-Extensions/blob/master/images/image1.png \"side menu\")\r\n\r\n## Install as developper\r\n\r\nTo install it as developper, download it from github:\r\n```\r\ngit clone https://github.com/oasys-esrf-kit/OASYS1-ESRF-Extensions\r\ncd OASYS1-ESRF-Extensions\r\n```\r\n\r\nThen link the source code to your Oasys python (note that you must use the python that Oasys uses): \r\n```\r\npython -m pip install -e . --no-deps --no-binary :all:\r\n```\r\n\r\nWhen restarting Oasys, you will see the ESRF addons there.\r\n\r\n## Upload new version to the pypi server\r\n\r\nFirst create a new version using your developper installation. Do not forget to increment the version number in setup.py\r\n\r\n+ Then run:\r\n\r\n```\r\npython setup.py sdist\r\n```\r\n\r\n+ Followed by:\r\n\r\n```\r\npython -m twine upload dist/OASYS1-ESRF-Extensions-X.X.X.tar.gz\r\n```\r\n\r\nYou need an account in pypi.org and be authorized in https://pypi.org/project/OASYS1-ESRF-Extensions/\r\n",
"bugtrack_url": null,
"license": "GPLv3",
"summary": "OASYS extension for the ESRF",
"version": "0.0.78",
"project_urls": {
"Download": "https://github.com/oasys-esrf-kit/OASYS1-ESRF-Extensions",
"Homepage": "https://github.com/oasys-esrf-kit/OASYS1-ESRF-Extensions"
},
"split_keywords": [
"raytracing",
" simulator",
" oasys1"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "393bf8e96fb305c91196a45aa04fe19a8746928ec69dedfdf4a1621746686bbf",
"md5": "95aec2a469197fce423684cbf51980d6",
"sha256": "e18991db0f78a5c98a8e9e4eac82b5c69069d79dfa6c35108bebeab67d330d85"
},
"downloads": -1,
"filename": "OASYS1-ESRF-Extensions-0.0.78.tar.gz",
"has_sig": false,
"md5_digest": "95aec2a469197fce423684cbf51980d6",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 3362521,
"upload_time": "2024-04-16T15:15:38",
"upload_time_iso_8601": "2024-04-16T15:15:38.446272Z",
"url": "https://files.pythonhosted.org/packages/39/3b/f8e96fb305c91196a45aa04fe19a8746928ec69dedfdf4a1621746686bbf/OASYS1-ESRF-Extensions-0.0.78.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-16 15:15:38",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "oasys-esrf-kit",
"github_project": "OASYS1-ESRF-Extensions",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "oasys1-esrf-extensions"
}
JSON
