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

Commit 931b554

Browse files
committed
Update documentation and use pysimcard dependency
1 parent ad48e51 commit 931b554

File tree

3 files changed

+30
-30
lines changed

3 files changed

+30
-30
lines changed

README.md

Lines changed: 23 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -5,23 +5,36 @@ Fields and values are specified in a CSV file, and optionally a filter script ca
55
## System Requirements
66
* Python 3.6 or later ([Python Installation Steps](python_installation_steps.md))
77

8-
## Python Package Dependencies:
9-
* pysim
10-
* 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
11-
* pandas
128

139
## Installation
14-
> _Windows_: substitute `python3` with `python`
10+
### Method #1: Source Distribution (`.tar.gz` file)
11+
Windows
12+
```
13+
python -m pip install --upgrade {sim_csv_script-VERSION.tar.gz}
14+
```
15+
16+
Linux
17+
```
18+
python3 -m pip install --upgrade {sim_csv_script-VERSION.tar.gz}
1519
```
16-
# Upgrade pip if using older version of Python
17-
python3 -m pip install --upgrade pip
1820

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

20-
python3 -m pip install --upgrade --no-cache-dir https://github.com/andrew-ma/sim_csv_script/archive/main.zip
24+
Windows
25+
```
26+
python -m pip install --upgrade -e .
27+
```
28+
29+
> _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++"
30+
31+
32+
Linux
33+
```
34+
python3 -m pip install --upgrade -e .
2135
```
22-
> _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.
2336

24-
> _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++"
37+
> _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
2538
2639

2740
---

development.md

Lines changed: 6 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -3,34 +3,21 @@
33
## System Requirements
44
* Python 3.6 or later ([Python Installation Steps](python-installation.md))
55

6-
## Python Package Dependencies:
7-
* pysim
8-
* 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
9-
* pandas
10-
11-
## Install for Development
12-
```
13-
git clone -b main https://github.com/andrew-ma/sim_csv_script
14-
cd sim_csv_script
15-
pip install -e .
16-
```
17-
18-
## Uninstall everything including dependencies
19-
```
20-
pip uninstall sim_csv_script -y
21-
pip uninstall -r requirements.txt -y
22-
```
23-
246
---
257

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

2911
Windows
3012
```
3113
make_distribution.bat
3214
```
3315

16+
Linux
17+
```
18+
# TODO: create make_distribution.bat equivalent bash script
19+
```
20+
3421
## Installing Source Distribution
3522
Windows
3623
```

requirements.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
1-
pysim @ https://github.com/andrew-ma/pysim/archive/master.zip
1+
pysimcard
22
pandas

0 commit comments

Comments
 (0)