|
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. |
4 | 5 |
|
5 | | -## Tutorial |
| 6 | +## Tutorial summary |
6 | 7 |
|
7 | | -## Requirements |
| 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. |
8 | 17 |
|
9 | | -traits |
10 | | -traitsui |
11 | | -chaco |
12 | | -openCV |
| 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 | + |
| 41 | +### pip users |
| 42 | +Assuming a Python environment is created and activated on your machine, for |
| 43 | +example from https://www.python.org/, |
| 44 | +```commandline |
| 45 | +pip install pandas matplotlib traits traitsui scikits-image |
| 46 | +``` |
13 | 47 |
|
14 | 48 | ## Contributing |
| 49 | +### Code structure |
| 50 | + |
| 51 | +### Rules for contributing to the repository |
| 52 | +Contributing to this repository requires: |
| 53 | +1. to make a Pull Request |
| 54 | +2. all code contributed must be pep8 compliant |
| 55 | +3. all unit tests must pass |
0 commit comments