Skip to content

Commit a1bc868

Browse files
Update README.md
1 parent 8c599f4 commit a1bc868

1 file changed

Lines changed: 18 additions & 15 deletions

File tree

README.md

Lines changed: 18 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,36 @@
1-
# HDPS (Version 0.3)
1+
![LogoWithText1](https://github.com/ManiVaultStudio/PublicWiki/assets/2978176/733c8d75-f1cc-4609-a39d-dcc8f7fcd6c3)
2+
(Version 1.0.0)
23

34
## Introduction
45

5-
The HDPS system is a modular plug-in system intended for visualization applications.
6-
7-
The system consists of a compact core which handles:
8-
9-
* Plug-in loading and dependency resolution
10-
* Data storage and data synchronization
11-
* Providing a base application window.
6+
ManiVault Studio is a modular plug-in system intended for visualization of high-dimensional datasets. Its plugin-based nature allows for the creation of fully-customizable applications that can be tailored perfectly to your datasets.
127

8+
The system consists of a compact core that provides a base application window, manages the datasets and plugin communication, as well as handle the saving and loading of projects.
9+
<!---
1310
Additionally, a complementary public library is generated which provides:
1411
1512
* The base classes from which all plug-ins extend
1613
* Basic rendering and computation classes
1714
* Graphics utility classes
1815
* Common GUI base classes
16+
-->
17+
The rest of the functionality of the system comes from fully self-contained plug-ins. These plug-ins can extend any of the following basic plug-in types:
1918

20-
## Requirements
19+
* **Data Plugin** - Can be extended to support custom data formats.
20+
* **View Plugin** - Can be extended to make custom visualizations of the data.
21+
* **Analysis Plugin** - Can be extended to perform custom analytics on the data.
22+
* **Transformation Plugin** - Can be extended to transform the data in-place.
23+
* **Loader/Writer Plugin** - Can be extended to import or export custom data formats.
2124

22-
* Qt 5.15 (https://www.qt.io/download)
25+
## Requirements
26+
* Qt 6.3 (https://www.qt.io/download)
2327

2428
## Documentation
25-
Documentation of the system is automatically generated by [Doxygen](http://www.doxygen.nl/) and available [here](hdps.github.io/documentation).
29+
Documentation of the system is automatically generated by [Doxygen](http://www.doxygen.nl/) and available [here](manivaultstudio.github.io/documentation).
2630

2731
## Developer Usage
2832

29-
1. Make sure Qt 5.15 or greater is installed on your system and is added to your Path environment variable.
30-
2. Retrieve the latest HDPS executable from [here](https://github.com/hdps/PublicWiki/releases/tag/v0.0.3)
33+
1. Make sure Qt 6.3 or greater is installed on your system and is added to your Path environment variable.
34+
2. Retrieve the latest ManiVault Studio executable from []()
3135
3. Download the .zip file and extract it on your computer
32-
4. Add a user environment variable called `HDPS_INSTALL_DIR` that points to the `HDPS` folder.
33-
5. Continue to write your first [plugin](https://github.com/hdps/PublicWiki/wiki/Writing-your-first-Plugin)
36+
4. Continue to write your first [plugin](https://github.com/hdps/PublicWiki/wiki/Writing-your-first-Plugin)

0 commit comments

Comments
 (0)