-
Notifications
You must be signed in to change notification settings - Fork 13
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Process fixes and README update (#114)
- Loading branch information
Showing
10 changed files
with
206 additions
and
136 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 |
---|---|---|
|
@@ -6,6 +6,7 @@ | |
|
||
[](https://github.com/ViennaTools/ViennaPS/actions/workflows/python.yml) | ||
[](https://github.com/ViennaTools/ViennaPS/actions/workflows/build.yml) | ||
[](https://pypi.org/project/ViennaPS/) | ||
|
||
</div> | ||
|
||
|
@@ -14,9 +15,23 @@ ViennaPS is a header-only C++ process simulation library, which includes surface | |
> [!NOTE] | ||
> ViennaPS is under heavy development and improved daily. If you do have suggestions or find bugs, please let us know! | ||
## Quick Start | ||
|
||
To install ViennaPS for Python, simply run: | ||
|
||
```sh | ||
pip install ViennaPS | ||
``` | ||
|
||
To use ViennaPS in C++, clone the repository and follow the installation steps below. | ||
|
||
For full documentation, visit [ViennaPS Documentation](https://viennatools.github.io/ViennaPS/). | ||
|
||
## Releases | ||
Releases are tagged on the master branch and available in the [releases section](https://github.com/ViennaTools/ViennaPS/releases). | ||
|
||
ViennaPS is also available on the [Python Package Index (PyPI)](https://pypi.org/project/ViennaPS/) for most platforms. | ||
|
||
## Building | ||
|
||
### Supported Operating Systems | ||
|
@@ -54,7 +69,7 @@ If the dependencies are not found on the system, they will be built from source. | |
> [!NOTE] | ||
> __For more detailed installation instructions and troubleshooting tips, please refer to the ViennaPS [documentation](https://viennatools.github.io/ViennaPS/inst/).__ | ||
ViennaPS operates as a header-only library, eliminating the need for a formal installation process. Nonetheless, we advise following the procedure to neatly organize and relocate all header files to a designated directory: | ||
ViennaPS is a header-only library, so no formal installation is required. However, following the steps below helps organize and manage dependencies more effectively: | ||
|
||
```bash | ||
git clone https://github.com/ViennaTools/ViennaPS.git | ||
|
@@ -77,7 +92,7 @@ cd ViennaPS | |
pip install . | ||
``` | ||
|
||
> Some functionalities of the ViennaPS Python module only work in combination with the ViennaLS Python module. It is therefore recommended to additionally install the ViennaLS Python module on your system. Instructions to do so can be found in the [ViennaLS Git Repository](https://github.com/ViennaTools/viennals). | ||
> Some features of the ViennaPS Python module require the ViennaLS Python module. It is therefore recommended to additionally install the ViennaLS Python module on your system. Instructions to do so can be found in the [ViennaLS Git Repository](https://github.com/ViennaTools/viennals). | ||
## Using the Python package | ||
|
||
|
@@ -149,6 +164,10 @@ This [example](https://github.com/ViennaTools/ViennaPS/tree/master/examples/hole | |
|
||
The image presents the results of different flux configurations, as tested in _testFluxes.py_. Each structure represents a variation in flux conditions, leading to differences in hole shape, depth, and profile characteristics. The variations highlight the influence of ion and neutral fluxes on the etching process. | ||
|
||
> [!NOTE] | ||
> The underlying model may change in future releases, so running this example in newer versions of ViennaPS might not always reproduce exactly the same results. | ||
> The images shown here were generated using **ViennaPS v3.3.0**. | ||
<div align="center"> | ||
<img src="assets/sf6o2_results.png" width=700 style="background-color:white;"> | ||
</div> | ||
|
@@ -228,7 +247,7 @@ cmake --build build --target format | |
|
||
## Authors | ||
|
||
Current contributors: Tobias Reiter, Noah Karnel, Lado Filipovic | ||
Current contributors: Tobias Reiter, Lado Filipovic, Noah Karnel | ||
|
||
Contact us via: [email protected] | ||
|
||
|
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
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
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
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
Oops, something went wrong.