Skip to content

Commit

Permalink
Simplify README.md
Browse files Browse the repository at this point in the history
Based on the comments
  • Loading branch information
Zhilin Zheng authored Jul 20, 2023
1 parent 457a3b1 commit 186171b
Showing 1 changed file with 6 additions and 10 deletions.
16 changes: 6 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)

</div>

# ViTables
Expand Down Expand Up @@ -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

Expand All @@ -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.

0 comments on commit 186171b

Please sign in to comment.