Skip to content

Commit

Permalink
Merge pull request #67 from 4dn-dcic/poetry_update
Browse files Browse the repository at this point in the history
Restore command line usage and update documentation, bump version
  • Loading branch information
clarabakker authored Nov 14, 2023
2 parents ebc01e7 + 35ddad6 commit 8125501
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 4 deletions.
10 changes: 7 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,10 +17,10 @@ The hic parsing code is based off the [straw project](https://github.com/theaide
$ pip install hic2cool
```

You can also download the code directly and run the setup yourself.
You can also download the code directly and install using Poetry (as of version 1.0.0)

```
# setuptools >=42 is recommended
$ python setup.py install
$ poetry install
```

Once the package is installed, the main method is hic2cool_convert. It takes the same parameters as hic2cool.py, described in the next section. Example usage in a Python script is shown below or in test.py.
Expand Down Expand Up @@ -119,6 +119,10 @@ You may also provide the optional `-e` flag, which will cause the mitchondrial c


## Changelog
### 1.0.1
* Restore command line usage, adds missing README update
### 1.0.0
* Switch to poetry, upgraded `python`, `numpy`, `cooler` versions, h5file I/O clean up, replace `multiprocessing` with `multiprocess'
### 0.8.3
* Partial fix for zlib decompression issue.
### 0.8.2
Expand Down
8 changes: 7 additions & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

[tool.poetry]
name = "hic2cool"
version = "1.0.0"
version = "1.0.1"
description = """Converter between hic files (from juicer) and single-resolution or multi-resolution cool files (for cooler). Both hic and cool files describe Hi-C contact matrices. Intended to be lightweight, this can be used as an imported package or a stand-alone Python tool for command line conversion."""
authors = ["Carl Vitzthum <[email protected]>"]
license = "MIT"
Expand Down Expand Up @@ -36,6 +36,12 @@ pandas = ">=1.0"
h5py = ">=2.5.0"
cooler = "0.9.3"


[tool.poetry.plugins]

[tool.poetry.plugins.console_scripts]
"hic2cool" = "hic2cool.__main__:main"

[build-system]
requires = ["poetry_core>=1.0.0"]
build-backend = "poetry.core.masonry.api"

0 comments on commit 8125501

Please sign in to comment.