-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
34 additions
and
9 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,15 +1,40 @@ | ||
# Qadence 2 core | ||
# Qadence 2 | ||
|
||
**Notice**: Qadence 2 is currently a *work in progress* and is under active development. Please be aware that the software is in an early stage, and frequent updates, including breaking changes, are to be expected. This means that: | ||
* Features and functionalities may change without prior notice. | ||
* The codebase is still evolving, and parts of the software may not function as intended. | ||
* Documentation and user guides may be incomplete or subject to significant changes. | ||
|
||
House for blocks, expressions, compiler, runtime, platforms (quantum model and backends) and data types handling modules. | ||
|
||
## Installation | ||
Installation guidelines | ||
|
||
## Usage | ||
Usage guidelines | ||
*Note*: it is adviced to set up a python environment before installing the package. | ||
|
||
|
||
To install the current version, there are a few options: | ||
|
||
### Installation from PYPI | ||
|
||
On the terminal, type | ||
|
||
```bash | ||
pip install qadence2 | ||
``` | ||
|
||
### Installation from Source | ||
|
||
Clone this repository by typing on the terminal | ||
|
||
```bash | ||
git clone https://github.com/pasqal-io/qadence2-core.git | ||
``` | ||
|
||
Go to `qadence2-core` folder and install it using [hatch](https://hatch.pypa.io/latest/) | ||
|
||
```bash | ||
hatch -v shell | ||
``` | ||
|
||
## Documentation | ||
Documentation guidelines | ||
## Contributing | ||
|
||
## Contribute | ||
Contribution guidelines | ||
## License |