Skip to content

Commit

Permalink
Merge pull request #11 from BritishGeologicalSurvey/update-readme-con…
Browse files Browse the repository at this point in the history
…tributors

Update README structure
  • Loading branch information
volcan01010 authored Aug 25, 2023
2 parents 7e493bf + 3cbe85f commit 2df5e4c
Showing 1 changed file with 58 additions and 49 deletions.
107 changes: 58 additions & 49 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

> A graphical tool for selecting points for analysis on an SEM image
### Download
## Download

You can download the **TACtool** application here:

Expand All @@ -11,7 +11,60 @@ You can download the **TACtool** application here:

Instructions for using the application can be found [here](https://github.com/BritishGeologicalSurvey/tactool/blob/main/instructions.md).

## Class Relationship Diagram
## Original Contributors

TACTool was initially developed within the British Geological Survey by:
- Connor Newstead
- Dan Sutton
- Declan Valters
- Leo Rudczenko
- John A Stevenson

The original idea was by Connor Newstead and Matt Horstwood.


## Development

### Installation

Check out the repository and install dependencies using Anaconda.

#### Windows
```bash
conda env create -f environments/windows-environment.yml
conda activate tactool-windows
```

#### MacOS
```bash
conda env create -f environments/macos-environment.yml
conda activate tactool-macos
```

### Running the Program

To run the program, first you need to setup your Python path.

#### Windows
```bash
$env:PYTHONPATH="."
```

#### MacOS
```bash
export PYTHONPATH=.
```

Then you can run the program with:

```bash
python tactool/main.py --dev
```

The `--dev` flag starts the application in developer mode, with a test image
pre-loaded into the GraphicsView.

### Class Relationship Diagram

<details>
<summary>Mermaid JS Code</summary>
Expand Down Expand Up @@ -224,54 +277,15 @@ Instructions for using the application can be found [here](https://github.com/Br

![TACtool - Class Relationship Diagram](class_relationship_diagram.png)

## Installation

Check out the repository and install dependencies using Anaconda.

### Windows
```bash
conda env create -f environments/windows-environment.yml
conda activate tactool-windows
```

### MacOS
```bash
conda env create -f environments/macos-environment.yml
conda activate tactool-macos
```

## Running the Program

To run the program, first you need to setup your Python path.

#### Windows
```bash
$env:PYTHONPATH="."
```

#### MacOS
```bash
export PYTHONPATH=.
```

Then you can run the program with:

```bash
python tactool/main.py --dev
```

The `--dev` flag starts the application in developer mode, with a test image
pre-loaded into the GraphicsView.

## Running tests
### Testing

Ensure you have setup your Python path. Then you can run the tests with:

```bash
pytest -vv test/
```

### List of Tests
#### List of Tests

**test_integration.py**
- test_add_and_remove_points
Expand All @@ -290,7 +304,7 @@ pytest -vv test/
- test_analysis_point_public_attributes_match
- test_model

## Create a standalone executable using PyInstaller
### Create a standalone executable using PyInstaller

```
pyinstaller --name="TACtool" --windowed --paths=. --onefile tactool/main.py
Expand All @@ -302,8 +316,3 @@ Run the above code and a .spec file and dist/ build/ directories will be created
TACtool is distributed under the [GPL v3.0 licence](LICENSE).

Copyright: © BGS / UKRI 2023

## Original Contributors

TACTool was initially developed within the British Geological Survey by Connor Newstead, Dan Sutton, Declan Valters, Leo Rudczenko and John A Stevenson.
The original idea was by Matt Horstwood.

0 comments on commit 2df5e4c

Please sign in to comment.