Skip to content

Commit 482082f

Browse files
Merge pull request #2 from jonathanrocher/doc/add_install_instructions_summary
Doc: add install instructions summary
2 parents 0a28524 + 6b45e30 commit 482082f

File tree

1 file changed

+67
-9
lines changed

1 file changed

+67
-9
lines changed

README.md

Lines changed: 67 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,72 @@
1-
# ets_tutorial
2-
This repository contains an Enthought Tool Suite tutorial submitted for the
3-
SciPy2019 conference.
1+
# Sharing your scientific tools: from a script to a desktop application
2+
This repository contains a GUI building and packaging tutorial using the
3+
[Enthought Tool Suite](https://docs.enthought.com/ets/) accepted for the
4+
[SciPy2022 conference](https://www.scipy2022.scipy.org/).
45

5-
## Tutorial
6+
## Tutorial summary
7+
8+
In this workshop, we will learn to embed scientific tools into a robust
9+
scientific application that can scale from a tiny UI to a large platform. As an
10+
example, attendees will build an image browser application (including
11+
face-detection capabilities), allowing users to search through their pictures,
12+
based on various criteria. We will start from a simple jupyter notebook and
13+
progressively turn it into a complete application using Matplotlib and several
14+
packages from the Enthought Tool Suite such as Traits, TraitsUI and Pyface. In
15+
the process, attendees will learn how to design clean, maintainable and
16+
scalable applications, and package them into an installer.
17+
18+
## Set up instructions
19+
20+
### Requirements
21+
22+
- Python 3.6+
23+
- Pandas
24+
- matplotlib
25+
- traits
26+
- traitsui
27+
- scikits.image
28+
29+
### EDM users (recommended)
30+
First, download and install EDM from https://www.enthought.com/edm/. Then, run
31+
the following in `Terminal`/`Powershell`/`Cmd Prompt`/... to create a dedicated
32+
Python environment and install all dependencies in it:
33+
```commandline
34+
edm env create ets_tutorial
35+
edm shell -e ets_tutorial
36+
edm install pandas matplotlib traits traitsui scikits.image
37+
```
38+
39+
### Conda users
40+
[TODO]
41+
42+
### pip users
43+
Assuming a Python environment is created and activated on your machine, for
44+
example from https://www.python.org/,
45+
```commandline
46+
pip install pandas matplotlib traits traitsui scikits-image
47+
```
48+
49+
## Getting help
50+
### During the tutorial
51+
During the tutorial, don't hesitate to ask for help:
52+
- ask questions if something isn't clear,
53+
- there will be a number of developers in the room who can help unblock you.
54+
55+
### After the tutorial
56+
- This tutorial was recorded and can be watched [here]() [TODO]
57+
- You can ask questions about any of the ETS packages on the ETS mailing list:
58+
https://groups.google.com/g/ets-users .
59+
- Each of the other packages has its own dedicated mailing list where questions
60+
can be posted.
661

7-
## Requirements
862

9-
traits
10-
traitsui
11-
chaco
12-
openCV
1363

1464
## Contributing
65+
### Code structure
66+
[TODO]
67+
68+
### Rules for contributing to the repository
69+
Contributing to this repository requires:
70+
1. to make a Pull Request
71+
2. all code contributed must be pep8 compliant
72+
3. all unit tests must pass

0 commit comments

Comments
 (0)