From fc9688573f512dec2ba389f9ab33c6fc49d18b32 Mon Sep 17 00:00:00 2001 From: Zhilin Zheng Date: Thu, 20 Jul 2023 10:41:06 +0800 Subject: [PATCH 1/4] Create README.md temp save, continue to work on VScode --- README.md | 84 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 84 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..151e4b1 --- /dev/null +++ b/README.md @@ -0,0 +1,84 @@ +![Platform](https://anaconda.org/conda-forge/vitables/badges/platforms.svg) ![License](https://anaconda.org/conda-forge/vitables/badges/license.svg) + +![Conda](https://anaconda.org/conda-forge/vitables/badges/version.svg) ![Conda_downloads](https://anaconda.org/conda-forge/vitables/badges/downloads.svg) ![PyPI](https://img.shields.io/pypi/v/vitables) ![PyPI_Downloads](https://static.pepy.tech/badge/vitables/month) + +# ViTables + +ViTables is a graphical tool for browsing and editing files in both PyTables +and HDF5 format. With ViTables you can easily navigate through the data +hierarchy, view and modify metadata, view actual data and more. + +ViTables has been developed using Python and PyQt, a binding to Qt +libraries, so it should run on any platform that support these components +(this includes Windows, Mac OS X, Linux and many other Unices). The interface +and features are the same in all platforms. At the moment, ViTables has been +heavily tested on Linux and Windows platforms. + +## Installation + +### System requirements + +ViTables 3.0.2 has been tested against the latest versions of Python 3, +PyTables and PyQt. You can try other versions at your own risk :). + +### Installation on a conda environment + +Using conda you should be able to run vitables on any system, let it +be linux, mac or windows. The following are instructions for linux-like +systems. + +Simply run:: + + $ conda install -c conda-forge vitables + +### Installation on Windows and Mac OS X platforms + +Currently there are no graphical installers available for these platforms. You +have to install ViTables from the command line, using one of the methods +described in the Linux section. + +### Installation on Linux platforms + +The Python setuptools are used to build and install ViTables. + +The easiest way to install it is to download it from PyPi:: + + $ pip install ViTables + +Alternatively, you can download the binary package from the download area +(see vitables.org/Downloads for details), go to the directory where you have +downloaded the file and issue the command:: + + $ pip install ViTables-3.0.2-py3-none-any.whl + +This should install the ViTables wheel. If you experience problems installing +the binary package then you can install from sources (provided your system fulfills +the requirements listed in the above section). Just download the tarball from +the download area, uncompress it, change to the distribution directory and execute + + $ python setup.py install + +If you are doing this on a MacOS X platform, please make sure that the +DYLD_LIBRARY_PATH environment variable has been setup properly. + +If you are installing with a system Python then you will need superuser privileges +because ViTables will be installed in the system-protected area where +your system installs third party Python packages. If you prefer to install the package +in a different location (for instance, your home directory) so that the installation can be done by +non privileged users, you can do it using the --prefix (or --home) tag + + $ python setup.py install --prefix=/home/myuser/mystuff + +Please, remember that installing Python modules in non-standard locations +makes it necessary to setup properly the PYTHONPATH environment variable so +that the Python interpreter can find the new modules. + +If you need further customizations, please have a look to the output of the +command + + $python setup.py install --help + +to see all the available options. + +Feel free to subscribe to the [ViTables users group](https://groups.google.com/forum/#!forum/vitables-users) and to report bugs and +send suggestions or features requests. From 50ad2ed47dab22e4fa39bc962df36a85c8336ea6 Mon Sep 17 00:00:00 2001 From: Zhilin Zheng Date: Thu, 20 Jul 2023 15:07:52 +0800 Subject: [PATCH 2/4] update README --- README.md | 98 ++++++++---------- README.txt | 18 ---- doc/images/logo.svg | 246 ++++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 291 insertions(+), 71 deletions(-) delete mode 100644 README.txt create mode 100644 doc/images/logo.svg diff --git a/README.md b/README.md index 151e4b1..578684e 100644 --- a/README.md +++ b/README.md @@ -1,84 +1,76 @@ +
+ +![title_page_plain](doc/images/title_page_plain.svg) + ![Platform](https://anaconda.org/conda-forge/vitables/badges/platforms.svg) ![License](https://anaconda.org/conda-forge/vitables/badges/license.svg) ![Conda](https://anaconda.org/conda-forge/vitables/badges/version.svg) ![Conda_downloads](https://anaconda.org/conda-forge/vitables/badges/downloads.svg) ![PyPI](https://img.shields.io/pypi/v/vitables) ![PyPI_Downloads](https://static.pepy.tech/badge/vitables/month) -# ViTables +![logo](doc/images/logo.svg) -ViTables is a graphical tool for browsing and editing files in both PyTables -and HDF5 format. With ViTables you can easily navigate through the data -hierarchy, view and modify metadata, view actual data and more. +
-ViTables has been developed using Python and PyQt, a binding to Qt -libraries, so it should run on any platform that support these components -(this includes Windows, Mac OS X, Linux and many other Unices). The interface -and features are the same in all platforms. At the moment, ViTables has been -heavily tested on Linux and Windows platforms. +# ViTables -## Installation +ViTables is a component of the PyTables family. It is a GUI for browsing and editing files in both PyTables and HDF5 formats. It is developed using Python and PyQt5 (the Python bindings to Qt), so it can run on any platform that supports these components. -### System requirements +ViTables capabilities include easy navigation through the data hierarchy, displaying of real data and its associated metadata, a simple, yet powerful, browsing of multidimensional data and much more. -ViTables 3.0.2 has been tested against the latest versions of Python 3, -PyTables and PyQt. You can try other versions at your own risk :). +
-### Installation on a conda environment +![mainWindow](doc/images/mainWindow.png) -Using conda you should be able to run vitables on any system, let it -be linux, mac or windows. The following are instructions for linux-like -systems. +
-Simply run:: +As a viewer, one of the greatest strengths of ViTables is its ability to display very large datasets. Tables with one thousand millions of rows (and beyond) are navigated stunningly fast and with very low memory requirements. So, if you ever need to browse huge tables, don't hesitate, ViTables is your choice. - $ conda install -c conda-forge vitables +If you need a customized browser for managing your HDF5 data, ViTables is an excellent starting point. -### Installation on Windows and Mac OS X platforms +
-Currently there are no graphical installers available for these platforms. You -have to install ViTables from the command line, using one of the methods -described in the Linux section. +![propertiesDlg](doc/images/propertiesDlg.png) +![editingUserAttrs](doc/images/editingUserAttrs.png) +![groupCreation](doc/images/groupCreation.png) +![helpBrowser](doc/images/helpBrowser.png) +![treeSymbols](doc/images/treeSymbols.png) -### Installation on Linux platforms +
-The Python setuptools are used to build and install ViTables. +## QuickStart -The easiest way to install it is to download it from PyPi:: +### System requirements - $ pip install ViTables +ViTables 3.0.2 has been tested against the latest versions of Python 3, +PyTables and PyQt. You can try other versions at your own risk :). -Alternatively, you can download the binary package from the download area -(see vitables.org/Downloads for details), go to the directory where you have -downloaded the file and issue the command:: +### Install through pip (may need further manually debug) - $ pip install ViTables-3.0.2-py3-none-any.whl +```sh +$ pip install ViTables +$ vitables +``` -This should install the ViTables wheel. If you experience problems installing -the binary package then you can install from sources (provided your system fulfills -the requirements listed in the above section). Just download the tarball from -the download area, uncompress it, change to the distribution directory and execute +The second command launches vitables, but you may encounter `module 'collections' has no attribute 'Iterable'` error, if so, see [FAQ](#FAQ) for solution. - $ python setup.py install +### Install on a conda environment -If you are doing this on a MacOS X platform, please make sure that the -DYLD_LIBRARY_PATH environment variable has been setup properly. +Using conda you should be able to run vitables on any system, let it +be linux, mac or windows. The following are instructions for linux-like +systems. -If you are installing with a system Python then you will need superuser privileges -because ViTables will be installed in the system-protected area where -your system installs third party Python packages. If you prefer to install the package -in a different location (for instance, your home directory) so that the installation can be done by -non privileged users, you can do it using the --prefix (or --home) tag +Simply run - $ python setup.py install --prefix=/home/myuser/mystuff +```sh +$ conda install -c conda-forge vitables +$ vitables +``` -Please, remember that installing Python modules in non-standard locations -makes it necessary to setup properly the PYTHONPATH environment variable so -that the Python interpreter can find the new modules. +For more details, see [INSTALL.txt](INSTALL.txt). -If you need further customizations, please have a look to the output of the -command +### FAQ - $python setup.py install --help +Q: Launch vitables failed due to error: -to see all the available options. + `module 'collections' has no attribute 'Iterable'` -Feel free to subscribe to the [ViTables users group](https://groups.google.com/forum/#!forum/vitables-users) and to report bugs and -send suggestions or features requests. +A: Change `collections.Iterable` to `collections.abc.Iterable` in line 152 and 180 of corresponding utils.py \ No newline at end of file diff --git a/README.txt b/README.txt deleted file mode 100644 index 5d884dd..0000000 --- a/README.txt +++ /dev/null @@ -1,18 +0,0 @@ -ViTables --------- -ViTables is a graphical tool for browsing and editing files in both PyTables -and HDF5 format. With ViTables you can easily navigate through the data -hierarchy, view and modify metadata, view actual data and more. - -ViTables has been developed using Python and PyQt, a binding to Qt -libraries, so it should run on any platform that support these components -(this includes Windows, Mac OS X, Linux and many other Unices). The interface -and features are the same in all platforms. At the moment, ViTables has been -heavily tested on Linux and Windows platforms. - -For installation instructions see INSTALL.txt. - -Feel free to subscribe to the ViTables users group [1]_ and to report bugs and -send suggestions or features requests. - - .. [1] https://groups.google.com/forum/#!forum/vitables-users diff --git a/doc/images/logo.svg b/doc/images/logo.svg new file mode 100644 index 0000000..28ed9d1 --- /dev/null +++ b/doc/images/logo.svg @@ -0,0 +1,246 @@ + + + + + + + + + + + + + + + + + + + + + image/svg+xml + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + From 457a3b18285c59e43fa3a8d3f0b0bdb9c1feba73 Mon Sep 17 00:00:00 2001 From: Zhilin Zheng Date: Thu, 20 Jul 2023 15:17:43 +0800 Subject: [PATCH 3/4] Update README.md Hide many screenshots for simplicity --- README.md | 12 ++---------- 1 file changed, 2 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 578684e..7dfdaed 100644 --- a/README.md +++ b/README.md @@ -26,15 +26,7 @@ As a viewer, one of the greatest strengths of ViTables is its ability to display If you need a customized browser for managing your HDF5 data, ViTables is an excellent starting point. -
- -![propertiesDlg](doc/images/propertiesDlg.png) -![editingUserAttrs](doc/images/editingUserAttrs.png) -![groupCreation](doc/images/groupCreation.png) -![helpBrowser](doc/images/helpBrowser.png) -![treeSymbols](doc/images/treeSymbols.png) - -
+Here are some [screenshots](doc/images). ## QuickStart @@ -73,4 +65,4 @@ Q: Launch vitables failed due to error: `module 'collections' has no attribute 'Iterable'` -A: Change `collections.Iterable` to `collections.abc.Iterable` in line 152 and 180 of corresponding utils.py \ No newline at end of file +A: Change `collections.Iterable` to `collections.abc.Iterable` in line 152 and 180 of corresponding utils.py From 186171bc876ba79c819b27abce5b035c1684b8c5 Mon Sep 17 00:00:00 2001 From: Zhilin Zheng Date: Thu, 20 Jul 2023 23:51:16 +0800 Subject: [PATCH 4/4] Simplify README.md Based on the comments --- README.md | 16 ++++++---------- 1 file changed, 6 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 7dfdaed..23e8549 100644 --- a/README.md +++ b/README.md @@ -6,8 +6,6 @@ ![Conda](https://anaconda.org/conda-forge/vitables/badges/version.svg) ![Conda_downloads](https://anaconda.org/conda-forge/vitables/badges/downloads.svg) ![PyPI](https://img.shields.io/pypi/v/vitables) ![PyPI_Downloads](https://static.pepy.tech/badge/vitables/month) -![logo](doc/images/logo.svg) - # ViTables @@ -39,10 +37,9 @@ PyTables and PyQt. You can try other versions at your own risk :). ```sh $ pip install ViTables -$ vitables ``` -The second command launches vitables, but you may encounter `module 'collections' has no attribute 'Iterable'` error, if so, see [FAQ](#FAQ) for solution. +If you may encounter `module 'collections' has no attribute 'Iterable'` error, simply change `collections.Iterable` to `collections.abc.Iterable` in line 152 and 180 of corresponding utils.py ### Install on a conda environment @@ -54,15 +51,14 @@ Simply run ```sh $ conda install -c conda-forge vitables -$ vitables ``` For more details, see [INSTALL.txt](INSTALL.txt). -### FAQ - -Q: Launch vitables failed due to error: +### Launch - `module 'collections' has no attribute 'Iterable'` +```sh +$ vitables [/path/to/hdf5/file] +``` -A: Change `collections.Iterable` to `collections.abc.Iterable` in line 152 and 180 of corresponding utils.py +If `/path/to/hdf5/file` is given, vitables will load that file, otherwise, you need to select a file to open later.