|
1 | 1 | # pointcloudutils
|
2 | 2 |
|
3 |
| -[](https://github.com/AllenCellModeling/pointcloudutils/actions) |
4 |
| -[](https://AllenCellModeling.github.io/pointcloudutils/) |
5 |
| -[](https://codecov.io/gh/AllenCellModeling/pointcloudutils) |
6 |
| - |
7 | 3 | Utils and networks for point cloud related projects at AICS
|
8 | 4 |
|
9 | 5 | ---
|
10 | 6 |
|
11 |
| -## Features |
12 |
| - |
13 |
| -- Store values and retain the prior value in memory |
14 |
| -- ... some other functionality |
15 |
| - |
16 |
| -## Quick Start |
| 7 | +First install cyto_dl. Then |
17 | 8 |
|
18 |
| -```python |
19 |
| -from pointcloudutils import Example |
| 9 | +```bash |
| 10 | +pip install -e . |
20 | 11 |
|
21 |
| -a = Example() |
22 |
| -a.get_value() # 10 |
| 12 | +pip install "git+https://github.com/erikwijmans/Pointnet2_PyTorch.git#egg=pointnet2_ops&subdirectory=pointnet2_ops_lib" |
| 13 | +pip install --upgrade https://github.com/unlimblue/KNN_CUDA/releases/download/0.2/KNN_CUDA-0.2-py3-none-any.whl |
23 | 14 | ```
|
24 | 15 |
|
25 |
| -## Installation |
26 |
| - |
27 |
| -**Stable Release:** `pip install pointcloudutils`<br> |
28 |
| -**Development Head:** `pip install git+https://github.com/AllenCellModeling/pointcloudutils.git` |
29 |
| - |
30 |
| -## Documentation |
31 |
| - |
32 |
| -For full package documentation please visit [AllenCellModeling.github.io/pointcloudutils](https://AllenCellModeling.github.io/pointcloudutils). |
33 |
| - |
34 |
| -## Development |
35 |
| - |
36 |
| -See [CONTRIBUTING.md](CONTRIBUTING.md) for information related to developing the code. |
37 |
| - |
38 |
| -## The Four Commands You Need To Know |
39 |
| - |
40 |
| -1. `pip install -e .[dev]` |
41 |
| - |
42 |
| - This will install your package in editable mode with all the required development |
43 |
| - dependencies (i.e. `tox`). |
44 |
| - |
45 |
| -2. `make build` |
46 |
| - |
47 |
| - This will run `tox` which will run all your tests in both Python 3.7 |
48 |
| - and Python 3.8 as well as linting your code. |
49 |
| - |
50 |
| -3. `make clean` |
51 |
| - |
52 |
| - This will clean up various Python and build generated files so that you can ensure |
53 |
| - that you are working in a clean environment. |
54 |
| - |
55 |
| -4. `make docs` |
56 |
| - |
57 |
| - This will generate and launch a web browser to view the most up-to-date |
58 |
| - documentation for your Python package. |
59 |
| - |
60 |
| -#### Additional Optional Setup Steps: |
61 |
| - |
62 |
| -- Turn your project into a GitHub repository: |
63 |
| - - Make an account on [github.com](https://github.com) |
64 |
| - - Go to [make a new repository](https://github.com/new) |
65 |
| - - _Recommendations:_ |
66 |
| - - _It is strongly recommended to make the repository name the same as the Python |
67 |
| - package name_ |
68 |
| - - _A lot of the following optional steps are *free* if the repository is Public, |
69 |
| - plus open source is cool_ |
70 |
| - - After a GitHub repo has been created, run the commands listed under: |
71 |
| - "...or push an existing repository from the command line" |
72 |
| -- Register your project with Codecov: |
73 |
| - - Make an account on [codecov.io](https://codecov.io)(Recommended to sign in with GitHub) |
74 |
| - everything else will be handled for you. |
75 |
| -- Ensure that you have set GitHub pages to build the `gh-pages` branch by selecting the |
76 |
| - `gh-pages` branch in the dropdown in the "GitHub Pages" section of the repository settings. |
77 |
| - ([Repo Settings](https://github.com/AllenCellModeling/pointcloudutils/settings)) |
78 |
| -- Register your project with PyPI: |
79 |
| - - Make an account on [pypi.org](https://pypi.org) |
80 |
| - - Go to your GitHub repository's settings and under the |
81 |
| - [Secrets tab](https://github.com/AllenCellModeling/pointcloudutils/settings/secrets/actions), |
82 |
| - add a secret called `PYPI_TOKEN` with your password for your PyPI account. |
83 |
| - Don't worry, no one will see this password because it will be encrypted. |
84 |
| - - Next time you push to the branch `main` after using `bump2version`, GitHub |
85 |
| - actions will build and deploy your Python package to PyPI. |
86 |
| - |
87 |
| -#### Suggested Git Branch Strategy |
88 |
| - |
89 |
| -1. `main` is for the most up-to-date development, very rarely should you directly |
90 |
| - commit to this branch. GitHub Actions will run on every push and on a CRON to this |
91 |
| - branch but still recommended to commit to your development branches and make pull |
92 |
| - requests to main. If you push a tagged commit with bumpversion, this will also release to PyPI. |
93 |
| -2. Your day-to-day work should exist on branches separate from `main`. Even if it is |
94 |
| - just yourself working on the repository, make a PR from your working branch to `main` |
95 |
| - so that you can ensure your commits don't break the development head. GitHub Actions |
96 |
| - will run on every push to any branch or any pull request from any branch to any other |
97 |
| - branch. |
98 |
| -3. It is recommended to use "Squash and Merge" commits when committing PR's. It makes |
99 |
| - each set of changes to `main` atomic and as a side effect naturally encourages small |
100 |
| - well defined PR's. |
101 |
| - |
102 |
| - |
103 | 16 | **Allen Institute Software License**
|
104 | 17 |
|
0 commit comments