Skip to content
This repository has been archived by the owner on May 27, 2024. It is now read-only.

Commit

Permalink
Update documentation and use pysimcard dependency
Browse files Browse the repository at this point in the history
  • Loading branch information
andrew-ma committed Aug 3, 2021
1 parent ad48e51 commit 931b554
Show file tree
Hide file tree
Showing 3 changed files with 30 additions and 30 deletions.
33 changes: 23 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,23 +5,36 @@ Fields and values are specified in a CSV file, and optionally a filter script ca
## System Requirements
* Python 3.6 or later ([Python Installation Steps](python_installation_steps.md))

## Python Package Dependencies:
* pysim
* Right now it uses my fork, because of this commit (https://github.com/andrew-ma/pysim/commit/2f10406c9d3ba42787648fb0060475222531d905), and official repo doesn't accept pull requests on Github
* pandas

## Installation
> _Windows_: substitute `python3` with `python`
### Method #1: Source Distribution (`.tar.gz` file)
Windows
```
python -m pip install --upgrade {sim_csv_script-VERSION.tar.gz}
```

Linux
```
python3 -m pip install --upgrade {sim_csv_script-VERSION.tar.gz}
```
# Upgrade pip if using older version of Python
python3 -m pip install --upgrade pip

### Method #2: Source Code
* First, change into the directory that contains *`setup.py`* or *`setup.cfg`* file

python3 -m pip install --upgrade --no-cache-dir https://github.com/andrew-ma/sim_csv_script/archive/main.zip
Windows
```
python -m pip install --upgrade -e .
```

> _Windows_: if you get a "swig.exe" error while running the installation command, you will need to download the swig prebuilt executable (http://www.swig.org/download.html), extract the zip, and add the folder to your PATH. Try running the installation steps again, and if it fails with a "Visual Studio Build Tools" error, then you will need to download https://visualstudio.microsoft.com/visual-cpp-build-tools/, install it, and select the "Desktop development with C++"

Linux
```
python3 -m pip install --upgrade -e .
```
> _Linux_: if you get a "swig: not found" error while running the installation command, first ensure that Python 3.6 or later is installed ('`python3 --version`'). If so, install swig with '`sudo apt install swig`' and retry the installation command.

> _Windows_: if you get a "swig.exe" error while running the installation command, you will need to download the swig prebuilt executable (http://www.swig.org/download.html), extract the zip, and add the folder to your PATH. Then try running the installation again, and if it fails with a "Visual Studio Build Tools" error, then you will need to download https://visualstudio.microsoft.com/visual-cpp-build-tools/, install it, and select the "Desktop development with C++"
> _Linux_: if you get a "swig: not found" error while running the installation command, first ensure that Python 3.6 or later is installed (`python3 --version`). If so, install swig with `sudo apt install swig` and retry the installation command

---
Expand Down
25 changes: 6 additions & 19 deletions development.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,34 +3,21 @@
## System Requirements
* Python 3.6 or later ([Python Installation Steps](python-installation.md))

## Python Package Dependencies:
* pysim
* Currently uses my fork, because of this commit (https://github.com/andrew-ma/pysim/commit/2f10406c9d3ba42787648fb0060475222531d905), and official repo doesn't accept pull requests on Github
* pandas

## Install for Development
```
git clone -b main https://github.com/andrew-ma/sim_csv_script
cd sim_csv_script
pip install -e .
```

## Uninstall everything including dependencies
```
pip uninstall sim_csv_script -y
pip uninstall -r requirements.txt -y
```

---

## Creating a Source Distribution
> Source distribution file ("sim_csv_script-VERSION.tar.gz") will be created in *dist/* folder
* Source distribution file (*`sim_csv_script*-VERSION.tar.gz`*) will be created in *dist/* folder

Windows
```
make_distribution.bat
```

Linux
```
# TODO: create make_distribution.bat equivalent bash script
```

## Installing Source Distribution
Windows
```
Expand Down
2 changes: 1 addition & 1 deletion requirements.txt
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
pysim @ https://github.com/andrew-ma/pysim/archive/master.zip
pysimcard
pandas

0 comments on commit 931b554

Please sign in to comment.