Skip to content

Commit 7ed1c7d

Browse files
committed
Setup a look-a-like layout, to just have the basics
Removed legacy information and created a installation page mathing the github
1 parent e4799ba commit 7ed1c7d

5 files changed

Lines changed: 42 additions & 23 deletions

File tree

docs/src/home.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
# EasyreReflectometryApp
2+
This is the home of the [EasyReflectometryApp](https://github.com/easyScience/EasyReflectometryApp) documentation, which is build on the [Python library](https://github.com/easyScience/EasyReflectometryLib).
3+
4+
This documentation aims to give the user an overview of how to get started with the application.

docs/src/index.md

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,17 @@
1-
# EasyReflectometryApp
2-
3-
This is the home of the EasyReflectometry developer documentation, covering both the [application](https://github.com/easyScience/EasyReflectometryApp) and the [Python library](https://github.com/easyScience/EasyReflectometryLib) that it is built on.
4-
This is distinct from the [Python library documentation](https://docs.easyreflectometry.org), which covers how to use the Python library and details the API.
5-
This developer documentation is aimed at those interested in contributing to the EasyReflectometry project as a whole.
6-
Therefore, this will be where information for developers will be found, such as how to build a suitable development environment, Architectural Decision Records (ADRs) and information on how the continuous integration works.
1+
```{include} ./home.md
2+
```
73

84
```{toctree}
95
---
106
hidden: True
11-
---
12-
tutorial
7+
caption: Contents:
8+
maxdepth: 2
9+
---
1310
11+
installation.md
12+
tutorial.md
13+
tutorials/model_def.md
14+
tutorials/load_data.md
15+
tutorials/simple_fitting.md
16+
tutorials/settings.md
1417
```

docs/src/installation.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# Installation
2+
3+
To make the installation of EasyReflectometry as easy as possible, we prepare packaged releases for three major operating systems:
4+
- [Windows](https://github.com/EasyScience/EasyReflectometryApp/releases/download/v1.0.0/EasyReflectometryApp_v1.0.0_windows-2022.exe)
5+
- [MacOS (Intel)](https://github.com/EasyScience/EasyReflectometryApp/releases/download/v1.0.0/EasyReflectometryApp_v1.0.0_macos-13-Intel.zip)
6+
- [MacOS (Silicon)](https://github.com/EasyScience/EasyReflectometryApp/releases/download/v1.0.0/EasyReflectometryApp_v1.0.0_macos-14-AppleSilicon.zip)
7+
- [Linux (built on Ubuntu-24.04)](https://github.com/EasyScience/EasyReflectometryApp/releases/download/v1.0.0/EasyReflectometryApp_v1.0.0_ubuntu-22.04)
8+
- [Linux (built on Ubuntu-22.04)](https://github.com/EasyScience/EasyReflectometryApp/releases/download/v1.0.0/EasyReflectometryApp_v1.0.0_ubuntu-24.04)
9+
10+
If the relevant EasyReflectometry installation does not work on your system, then please try installation from source.
11+
12+
## Installation from source
13+
14+
1. Clone EasyReflectometryApp repo from GitHub
15+
> git clone https://github.com/easyScience/EasyReflectometryApp
16+
2. Clone EasyApp repo from GitHub
17+
> git clone https://github.com/easyScience/EasyApp
18+
3. Go to EasyReflectometryApp directory
19+
4. Create miniforge conda environment with the name era_311 for EasyReflectometryApp
20+
> conda create --name era_311 python=3.11
21+
5. Create environment for EasyReflectometryApp and install it and its dependences using pip
22+
> pip install -e .
23+
6. Launch EasyReflectometry application in the created environment
24+
> python EasyReflectometryApp/main.py

docs/src/tutorial.md

Lines changed: 2 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
# Tutorial
2-
This is the tutorial for getting started with EasyReflectometryApp and how to use it.
1+
# Getting started
2+
This is the tutorial for EasyReflectometryApp and how to use it.
33
Version: 1.0.0
44

55
## Home page
@@ -35,15 +35,3 @@ When a project is started two further buttons is visualised, and settings is the
3535
- **A**: Save project.
3636
- **B**: Reset to start.
3737
- **C**: Setting, is further explained in settings.
38-
39-
```{toctree}
40-
---
41-
maxdepth: 1
42-
---
43-
44-
tutorials/model_def.md
45-
tutorials/load_data.md
46-
tutorials/simple_fitting.md
47-
tutorials/settings.md
48-
49-
```

docs/src/tutorials/simple_fitting.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ The super-phase (where the neutrons are incident first) is a silicon (Si) wafer
66
Then a polymer film is attached to the silicon dioxide by some chemical method and this polymer film is solvated in heavy water (D<sub>2</sub>O) which also makes up the sub-phase of the system.
77
This is shown pictorially below, as a slab model.
88

9-
![A slab model description of the polymer film system.](./_images/polymer_film.png){width=50}
9+
![A slab model description of the polymer film system.](./_images/polymer_film.png)
1010

1111
Now for explaining the `Analysis` tab let's look at how the EasyReflectometryApp can fit. The tab is like the previous tabs split into two windows, a graph- and a data-window.<br>
1212
The graph window has the same functionality as the previous tabs, so it will not be explained further. The data window has two categories: `Basic` and `Advanced` controls.

0 commit comments

Comments
 (0)