Skip to content

Commit ec6e068

Browse files
committed
TL: added installation procedure
1 parent 106f623 commit ec6e068

File tree

3 files changed

+65
-13
lines changed

3 files changed

+65
-13
lines changed

README.md

Lines changed: 26 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,9 +56,34 @@ Any combination of block operators can be seen as a unique block operator, hence
5656
- `BlockIteration` objects depend only on `BlockOperator` objects, and are enough alone o define and analyse the speedup of a given block iteration (if relying only on symbolic `BlockOperator`)
5757
- `BlockProblem` represent the time-integration of a Dahlquist problem on a given time interval with a given number of blocks. It defines the appropriate numerical `BlockOperator`, and can be used to generate some classical `BlockIteration` objects.
5858

59+
## Installation
60+
61+
Download this repository using `git` :
62+
63+
```bash
64+
git clone https://github.com/Parallel-in-Time/time4apint.git
65+
```
66+
67+
then go within your local repository and install it with `pip` :
68+
69+
```bash
70+
cd time4apint
71+
pip install -e .
72+
```
73+
74+
💡 The `-e` option create symbolic links to the package in your python environment, and do not copy its files.
75+
That way, when there are new commits for the package in the github repo, you simply need to pull from it to update your local package :
76+
77+
```bash
78+
git pull # update your local repo => update automatically your package
79+
```
80+
81+
Also, if you do any development on your local package sources, those will be automatically used by your local python environment.
82+
83+
5984
## Project structure
6085

61-
### Base library :
86+
### Base library
6287

6388
- [blockops](./blockops/) : the main library developped for this project
6489
- [old](./old/) : some previous implementations (:ghost: to be integrated/removed later in the current code ...)

pyproject.toml

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
[build-system]
2+
requires = ["hatchling"]
3+
build-backend = "hatchling.build"
4+
5+
[tool.hatch.build.targets.wheel]
6+
packages = ["time4apint"]
7+
8+
[project]
9+
name = "time4apint"
10+
version = "0.0.2"
11+
description = "Analysis tool for iterative Parallel-in-Time algorithms"
12+
dependencies = [
13+
"numpy",
14+
"scipy",
15+
"sympy",
16+
"networkx",
17+
"matplotlib",
18+
"plotly",
19+
"wepps",
20+
"pytest",
21+
]
22+
requires-python = ">=3.10"
23+
maintainers = [
24+
{name = "Thibaut Lunet", email = "thibaut.lunet@tuhh.de"},
25+
]
26+
readme = "README.md"
27+
classifiers = [
28+
"Development Status :: 3 - Alpha",
29+
30+
"Topic :: Scientific/Engineering :: Mathematics",
31+
32+
"License :: OSI Approved :: BSD License",
33+
34+
"Programming Language :: Python :: 3",
35+
"Programming Language :: Python :: 3.10",
36+
"Programming Language :: Python :: 3.11",
37+
"Programming Language :: Python :: 3.12",
38+
"Programming Language :: Python :: 3.13",
39+
]

requirements.txt

Lines changed: 0 additions & 12 deletions
This file was deleted.

0 commit comments

Comments
 (0)