Skip to content

Commit 30dea31

Browse files
author
Ember Chow
committed
Fixup readme for v0.0.1
1 parent 8790ecd commit 30dea31

1 file changed

Lines changed: 21 additions & 33 deletions

File tree

README.md

Lines changed: 21 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,10 @@
11
# forcedimension-python
22

3-
Written and Mantained By: The Rothlab at IU: Bloomington
3+
![license](https://img.shields.io/github/v/release/EmDash00/forcedimension-python?display_name=tag)
44

5-
### Specific Contributors and Contributions:
5+
Written and Mantained By: The Rothlab at IU: Bloomington. Looking for the documentation? You can find it here:
66

7-
* Drason Chow ([EmDash00](https://github.com/EmDash00))
8-
- forcedimension.runtime
9-
- forcedimension.dhd.bindings
10-
- forcedimension.dhd.bindings.expert
11-
- forcedimension.dhd.bindings.adaptors
7+
https://forcedimension-python-documentation.readthedocs.io/en/latest/
128

139
## About
1410

@@ -30,12 +26,21 @@ The ForceDimensionSDK is a very well written interface that solves the problem o
3026

3127
### PyPI Package (recommended)
3228

33-
Not available at this time.
29+
```
30+
pip install forcedimension
31+
```
32+
33+
`numpy` is an optional dependency. If you want to install that as well:
3434

35-
### Manually
35+
```
36+
pip install forcedimension\[numpy\]
37+
```
3638

37-
#### Install the [ForceDimensionSDK](https://www.forcedimension.com/download/sdk) for your computer.
39+
40+
41+
#### Install the [ForceDimensionSDK](https://www.forcedimension.com/software/sdk) for your computer.
3842
By default, the bindings will search in the following system-wide install locations.
43+
3944
* System-wide install locations (Linux):
4045
- `/usr/local/lib`
4146
- `/usr/lib`
@@ -51,6 +56,7 @@ If you do not wish to make a system-wide installation set the FORCEDIM_SDK envir
5156
This requires extra steps since the Makefile for the ForceDimensionSDK does not offer a `make install` target for a system-wide install.
5257

5358
1. Copy all files from `lib/release/lin-*-gcc` to `/usr/local/lib`
59+
5460
2. Copy all files from `include` to `/usr/local/include`
5561

5662
3. MAKE SURE the libraries have `755` level access using `chmod`. If they don't applications cannot link or load them.
@@ -63,12 +69,12 @@ These steps can be automated by adding these targets to the Makefile.
6369
install:
6470
cp include/* /usr/local/include
6571
cp lib/release/lin-*-gcc/* /usr/local/lib
66-
chmod 755 /usr/local/lib/libdhd.so.3.9.1
67-
chmod 755 /usr/local/lib/libdrd.so.3.9.1
72+
chmod 755 /usr/local/lib/libdhd.so.X.X.X
73+
chmod 755 /usr/local/lib/libdrd.so.X.X.X
6874
chmod 755 /usr/local/lib/libdhd.a
6975
chmod 755 /usr/local/lib/libdrd.a
70-
ln -s /usr/local/lib/libdhd.so /usr/local/lib/libdhd.so.3.9.1
71-
ln -s /usr/local/lib/libdrd.so /usr/local/lib/libdrd.so.3.9.1
76+
ln -s /usr/local/lib/libdhd.so /usr/local/lib/libdhd.so.X.X.X
77+
ln -s /usr/local/lib/libdrd.so /usr/local/lib/libdrd.so.X.X.X
7278
```
7379

7480
```makefile
@@ -82,7 +88,7 @@ uninstall:
8288
rm /usr/local/lib/libdrd.so.3.9.1
8389
rm /usr/local/lib/libdrd.so
8490
```
85-
#### Driver installation
91+
#### Additional Setup
8692

8793
##### Windows
8894

@@ -104,21 +110,3 @@ MAKE SURE you unplug the USB and not just the power because the unpowering the d
104110

105111
Then perform `lsusb` and note the ID of your device, which is in the format `idVendor:idPorduct`
106112

107-
#### Python Bindings Installation
108-
109-
##### System wide
110-
111-
Clone this repository using `git clone https://github.com/EmDash00/forcedimension-python.git` or your choice in version control software.
112-
113-
Add the folder you cloned the repo into to your `PYTHONPATH` environment variable.
114-
115-
##### Locally (recommended)
116-
117-
Add this repository as a submodule to a project
118-
119-
```bash
120-
cd /path/to/project/folder
121-
git submodule add https://github.com/EmDash00/forcedimension-python.git
122-
git commit -m "Added forcedimension to my project"
123-
```
124-

0 commit comments

Comments
 (0)