Skip to content

Commit 4570426

Browse files
authored
Create README.md
1 parent 8a3e91a commit 4570426

File tree

1 file changed

+48
-0
lines changed

1 file changed

+48
-0
lines changed

README.md

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
# Strata-Excel
2+
3+
Strata-Excel provides Excel bindings to OpenGamma's Strata open source analytics and market risk library.
4+
5+
Strata can be found at https://github.com/OpenGamma/Strata.
6+
7+
## Using Strata-Excel
8+
9+
Strata-Excel uses Jinx, the Excel Java Add-in.
10+
11+
Jinx can be obtained from https://exceljava.com.
12+
13+
Once Jinx is installed the Strata-Excel JAR file must be added to the jinx.ini config file, along with the OpenGamma Strata library and dependencies.
14+
15+
```ini
16+
[JAVA]
17+
classpath =
18+
<path of strata-excel JAR file>
19+
<strata and dependencies>/*.jar
20+
```
21+
22+
## Building Strata-Excel
23+
24+
The source code can be cloned using git from GitHub:
25+
26+
```
27+
git clone https://github.com/exceljava/strata-excel.git
28+
```
29+
30+
The projects use Apache Maven as the build system. Version 3.5.0 or later is required. Simply run this command to compile and install the source code locally:
31+
32+
```
33+
mvn install
34+
```
35+
36+
Note that Strata-Excel is based on Java SE 8. Version 8u40 or later is required to compile the code.
37+
38+
## Extending Strata-Excel
39+
40+
Strata-Excel wraps the Strata types and methods to expose them to Excel.
41+
42+
These wrappers are generated automatically from the Strata source code via the Python script 'tools/generate_jinx_wrappers.py'
43+
and package 'tools/gencode'.
44+
45+
In order to add new types and methods to the Strata-Excel wrapper code, update the config files in 'tools/gencode/config' and run
46+
'tools/generate_jinx_wrappers.py. The folder structure of the config directory mirrors the Strata source.
47+
48+
Python 3.6 is required to build the wrappers.

0 commit comments

Comments
 (0)