Skip to content

Commit ae6d145

Browse files
committed
Preparation for v0.0.1 release
1 parent 7ea1361 commit ae6d145

File tree

3 files changed

+42
-15
lines changed

3 files changed

+42
-15
lines changed

CHANGELOG.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
## RTXpy Changelog
2+
------------------
3+
4+
### Version 0.0.1 - 8 October 2021
5+
- Initial release

README.md

Lines changed: 20 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,36 @@
11
# RTXpy
22

3-
Ray tracing using CUDA accessible from Python.
3+
Ray tracing using CUDA, accessible from Python.
44

5-
Requires CMake 3.10 or higher, either system CMake or can
5+
## Hardware requirements
66

7-
pip install cmake
7+
* Nvidia Maxwell GPU or newer
8+
* Nvidia driver version:
9+
* 456.71 or newer for Windows
10+
* 455.28 or newer for Linux
811

9-
To install
12+
## Installation
1013

11-
pip install -ve .
14+
pip install rtxpy
1215

13-
Optional runtime dependencies
16+
## Installation from source
1417

15-
cupy
18+
Requires CMake 3.10 or higher, either system CMake or
1619

17-
If you know the version of the CUDA toolkit that you have installed, which can
18-
be obtained by running `nvcc --version`, you can install the appropriate `cupy`
19-
wheel using
20+
pip install cmake
2021

21-
pip install cupy-cuda101
22+
To install RTXpy from source use
2223

23-
which is for CUDA toolkit 10.1
24+
pip install -ve .
25+
26+
`cupy` is an optional runtime dependency. If you know the version of the CUDA
27+
toolkit you have installed, which can be obtained by running `nvcc --version`,
28+
you can install the appropriate `cupy` wheel. For example, for CUDA toolkit
29+
10.1 use
30+
31+
pip install cupy-cuda101
2432

2533
To run tests
2634

2735
pip install -ve .[tests]
2836
pytest -v rtxpy/tests
29-
30-
**Requires NVIDIA R456.71 driver or newer for Windows and 455.28 or newer for Linux.**
31-
**Requires an NVidia Maxwell GPU or newer**

setup.cfg

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,22 @@
11
[metadata]
22
author = makepath
3+
author_email = [email protected]
4+
classifiers =
5+
Development Status :: 4 - Beta
6+
Intended Audience :: Developers
7+
Intended Audience :: Science/Research
8+
License :: OSI Approved :: MIT License
9+
Operating System :: Microsoft :: Windows
10+
Operating System :: POSIX :: Linux
11+
Programming Language :: C++
12+
Programming Language :: Python :: 3
13+
Programming Language :: Python :: 3.7
14+
Programming Language :: Python :: 3.8
15+
Programming Language :: Python :: 3.9
16+
Programming Language :: Python :: 3.10
17+
Topic :: Scientific/Engineering :: Information Analysis
18+
Topic :: Scientific/Engineering :: Mathematics
19+
Topic :: Scientific/Engineering :: Visualization
320
description = Ray tracing using CUDA accessible from Python
421
license = MIT
522
license_file = LICENSE

0 commit comments

Comments
 (0)