Skip to content

updated description #229

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
andped10 merged 1 commit into from
Nov 28, 2024
Merged

updated description #229

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 15 additions & 11 deletions INSTALLATION.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,29 +3,33 @@
To make the installation of EasyReflectometry as easy as possible, we prepare packaged releases for three major operating systems:

- [Windows](https://github.com/easyScience/EasyReflectometryApp/releases/download/v0.0.12/EasyReflectometry_Windows_x86-32_v0.0.12.exe)
- [macOS](https://github.com/easyScience/EasyReflectometryApp/releases/download/v0.0.12/EasyReflectometry_macOS_x86-64_v0.0.12.zip) (built on 10.15)
- [Linux](https://github.com/easyScience/EasyReflectometryApp/releases/download/v0.0.12/EasyReflectometry_Linux_x86-64_v0.0.12.zip) (built on Ubuntu-20.04)
- [MacOS](https://github.com/EasyScience/EasyReflectometryApp/releases/download/v1.0.0/EasyReflectometryApp_v1.0.0_macos-13-Intel.zip) (Intel)
- [MacOS](https://github.com/EasyScience/EasyReflectometryApp/releases/download/v1.0.0/EasyReflectometryApp_v1.0.0_macos-14-AppleSilicon.zip) (ARM)
- [Linux](https://github.com/EasyScience/EasyReflectometryApp/releases/download/v1.0.0/EasyReflectometryApp_v1.0.0_ubuntu-22.04) (built on Ubuntu-22.04)
- [Linux](https://github.com/EasyScience/EasyReflectometryApp/releases/download/v1.0.0/EasyReflectometryApp_v1.0.0_ubuntu-24.04) (built on Ubuntu-22.04)

If the relevant EasyReflectometry installation does not work on your system, then please try installation from source.

## Installation from source

1. Install [**Poetry**](https://python-poetry.org/docs/) isolated from the rest of your system (recommended)
1. Clone **EasyReflectometryApp** repo from GitHub
```
curl -sSL https://raw.githubusercontent.com/python-poetry/poetry/master/get-poetry.py | python
git clone https://github.com/easyScience/EasyReflectometryApp
```
2. Clone **EasyReflectometryApp** repo from GitHub
2. Clone **EasyApp** repo from GitHub
```
git clone https://github.com/easyScience/EasyReflectometryApp
git clone https://github.com/easyScience/EasyApp
```
3. Go to **EasyReflectometryApp** directory
4. Create virtual environment for **EasyReflectometryApp** and install it and its dependences using **pip**
4. Create miniforge conda environment with the name era_311 for **EasyReflectometryApp**
```
pip install .
conda create --name era_311 python=3.11
```
5. Launch **EasyReflectometry** application using **poetry**
5. Create environment for **EasyReflectometryApp** and install it and its dependences using **pip**
```
pip install -e .
```
6. Launch **EasyReflectometry** application in the created environment
```
python EasyReflectometryApp/main.py
```

It is also possible to install [poetry within a conda](https://anaconda.org/conda-forge/poetry) environment [if you really need to](https://xkcd.com/1987/), but this is not recommended.