pyxirr
Rust-powered collection of financial functions.
File Explorer
Download Latest Version (.zip)- config.toml
- bench.yaml
- ci.yaml
- FUNDING.yml
- comparison.rs
- input.rs
- npf.rs
- head.html
- direct_alpha.md
- dpi.md
- ks_pme.md
- ks_pme_flows.md
- ln_pme.md
- ln_pme_nav.md
- m_pme.md
- moic.md
- pme_plus.md
- pme_plus_flows.md
- pme_plus_lambda.md
- rvpi.md
- tvpi.md
- day_count_conventions.md
- index.html
- list-in-default-out.png
- list-in-list-out.png
- ndarray-in-default-out.png
- ndarray-in-ndarray-out.png
- data.js
- index.html
- main.js
- styles.css
- bench.png
- _config.yaml
- functions.md
- index.md
- install.md
- private_equity.md
- __init__.py
- _pyxirr.pyi
- pe.pyi
- py.typed
- day_count.rs
- mod.rs
- xirr.rs
- xnfv.rs
- mod.rs
- models.rs
- optimize.rs
- periodic.rs
- private_equity.rs
- utils.rs
- broadcasting.rs
- conversions.rs
- lib.rs
- cases.rs
- helpers.rs
- mod.rs
- 1938.csv
- 30-0.csv
- 30-1.csv
- 30-10.csv
- 30-11.csv
- 30-12.csv
- 30-13.csv
- 30-14.csv
- 30-15.csv
- 30-16.csv
- 30-17.csv
- 30-18.csv
- 30-19.csv
- 30-2.csv
- 30-20.csv
- 30-21.csv
- 30-22.csv
- 30-23.csv
- 30-24.csv
- 30-25.csv
- 30-26.csv
- 30-27.csv
- 30-28.csv
- 30-29.csv
- 30-3.csv
- 30-30.csv
- 30-31.csv
- 30-32.csv
- 30-33.csv
- 30-34.csv
- 30-35.csv
- 30-36.csv
- 30-37.csv
- 30-38.csv
- 30-39.csv
- 30-4.csv
- 30-40.csv
- 30-41.csv
- 30-42.csv
- 30-43.csv
- 30-44.csv
- 30-45.csv
- 30-46.csv
- 30-47.csv
- 30-48.csv
- 30-5.csv
- 30-6.csv
- 30-7.csv
- 30-8.csv
- 30-9.csv
- minus_0_13.csv
- minus_0_99.csv
- minus_0_993.csv
- minus_0_99999.csv
- random.csv
- random_100.csv
- random_1000.csv
- random_500.csv
- rw-100.csv
- rw-1000.csv
- rw-50.csv
- rw-500.csv
- single_redemption.csv
- unordered.csv
- xnfv.csv
- zeros.csv
- test_conversion.rs
- test_periodic.rs
- test_scheduled.rs
- .gitignore
- .rustfmt.toml
- bench-requirements.txt
- Cargo.lock
- Cargo.toml
- CHANGELOG.md
- dev-requirements.txt
- LICENSE
- pyproject.toml
- README.md
# Installation Guide
1. Get the code
git clone https://github.com/Anexen/pyxirr
Downloads the entire project code from GitHub to your computer.
cd pyxirr
Moves into the project folder you just downloaded.
2. Official Install Script
Easy RecommendedPrerequisites
- Python 3 Python is required to use pip.
pip install pyxirr
Installs the package published on PyPI directly โ no need to clone the source.
After installing, open a new terminal and run the program's version command (e.g. --version) to confirm it worked.
Pulled directly from this repo's README.
3. Python
EasyPrerequisites
pip install pyxirr
Installs the package published on PyPI directly โ no need to clone the source.
$ pip install -r dev-requirements.txt
Installs the Python libraries listed in requirements.txt (or similar).
$ pip install -r bench-requirements.txt
Installs the Python libraries listed in requirements.txt (or similar).
If it runs without errors and prints output in the terminal, it worked.
Pulled directly from this repo's README.
4. Rust
MediumPrerequisites
- Git Needed to download the project code from GitHub.
- Rust (rustup) Installing via rustup also installs cargo.
$ LD_LIBRARY_PATH=${PYENV_ROOT}/versions/3.10.8/lib cargo test
Type this command into your terminal and run it.
$ LD_LIBRARY_PATH=${PYENV_ROOT}/versions/3.10.8/lib cargo +nightly bench
Type this command into your terminal and run it.
If cargo build finishes without errors, it worked. The executable is created under target/.
Pulled directly from this repo's README.
// repository documentation
Was this content helpful?
(0 ratings)