Skip to content

Commit 2d075bc

Browse files
code2k13code2k13
committed
updated documentation
1 parent 1695a86 commit 2d075bc

File tree

2 files changed

+113
-87
lines changed

2 files changed

+113
-87
lines changed

‎docs/index.html‎

Lines changed: 113 additions & 87 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,12 @@
1010
<link href="https://cdn.jsdelivr.net/npm/[email protected]/fonts/remixicon.css" rel="stylesheet">
1111
<link rel="icon" type="image/x-icon" href="starrem.ico">
1212

13+
14+
<meta property="og:image" content="starrem2k13_og.jpg">
15+
<meta property="og:image:type" content="image/png">
16+
<meta property="og:image:width" content="1024">
17+
<meta property="og:image:height" content="1024">
18+
1319
<style>
1420
code {
1521
background-color: #343a40 !important;
@@ -51,146 +57,166 @@
5157
<div class="p-1 mb-1 bg-light rounded-3">
5258
<div class="container-fluid py-1 text-center">
5359

54-
<p class="col-md-12 fs-4">
55-
56-
<img src="star2k13_video.gif" style="width:100%;max-width: 360px;" /> <br/>
60+
<p class="col-md-12 fs-4">
61+
62+
<img src="star2k13_video.gif" style="width:100%;max-width: 360px;" /> <br />
5763

5864
Starrem2k13, a simple, easy tool and open source for removing stars from deep sky images.
5965
<br />
60-
<a class="btn btn-outline-secondary btn-sm" type="button" href="https://ashishware.com/static/star_removal/index.html">Try Online Demo <i
66+
<a class="btn btn-outline-secondary btn-sm" type="button"
67+
href="https://ashishware.com/static/star_removal/index.html">Try Online Demo <i
6168
class="ri-window-line"></i></a>
62-
<a class="btn btn-outline-secondary btn-sm" type="button" href="https://github.com/code2k13/starrem2k13#running-using-docker-recommended">Run with Docker </a>
69+
<a class="btn btn-outline-secondary btn-sm" type="button"
70+
href="https://github.com/code2k13/starrem2k13#running-using-docker-recommended">Run with Docker
71+
</a>
6372

6473
<a class="btn btn-outline-secondary btn-sm" type="button" href="">Download for Windows <i
6574
class="ri-windows-line"></i></a>
66-
<a class="btn btn-outline-secondary btn-sm" type="button" href="https://github.com/code2k13/starrem2k13/releases/download/v2.0_linux/starrem2k13_ubuntu_20.04.tar.gz"> Download for Ubuntu 20/Linux <i
67-
class="ri-ubuntu-line"></i></a>
68-
<a class="btn btn-outline-secondary btn-sm" href="https://github.com/code2k13/starrem2k13/releases/download/v2.0_macos/starrem2k13_macos_12.tar.gz" type="button"> Download for MacOS <i
69-
class="ri-apple-line"></i></a>
75+
<a class="btn btn-outline-secondary btn-sm" type="button"
76+
href="https://github.com/code2k13/starrem2k13/releases/download/v2.0_linux/starrem2k13_ubuntu_20.04.tar.gz">
77+
Download for Ubuntu 20/Linux <i class="ri-ubuntu-line"></i></a>
78+
<a class="btn btn-outline-secondary btn-sm"
79+
href="https://github.com/code2k13/starrem2k13/releases/download/v2.0_macos/starrem2k13_macos_12.tar.gz"
80+
type="button"> Download for MacOS <i class="ri-apple-line"></i></a>
7081

7182

7283
</p>
7384
</div>
7485

7586

7687
</div>
77-
88+
7889

7990

8091
<h2 id="gettingstarted">Getting Started</h3>
81-
<div>
82-
83-
<div class="accordion" id="accordionExample">
84-
<div class="accordion-item">
85-
<h2 class="accordion-header" id="headingOne">
86-
<button class="accordion-button" type="button" data-bs-toggle="collapse"
87-
data-bs-target="#collapseOne" aria-expanded="true" aria-controls="collapseOne">
88-
Installing on Windows
89-
</button>
90-
</h2>
91-
<div id="collapseOne" class="accordion-collapse collapse show" aria-labelledby="headingOne"
92-
data-bs-parent="#accordionExample">
93-
<div class="accordion-body">
94-
Download the pre-built binaries for Windows <a href="https://github.com/code2k13/starrem2k13/releases/download/v2.1_win/starrem2k13_win.zip">here</a>. Simply unzip the downloaded zip archive and run the below command in command prompt:
95-
<br />
96-
<code lang="javascript">
92+
<div>
93+
94+
<div class="accordion" id="accordionExample">
95+
<div class="accordion-item">
96+
<h2 class="accordion-header" id="headingOne">
97+
<button class="accordion-button" type="button" data-bs-toggle="collapse"
98+
data-bs-target="#collapseOne" aria-expanded="true" aria-controls="collapseOne">
99+
Installing on Windows
100+
</button>
101+
</h2>
102+
<div id="collapseOne" class="accordion-collapse collapse show" aria-labelledby="headingOne"
103+
data-bs-parent="#accordionExample">
104+
<div class="accordion-body">
105+
Download the pre-built binaries for Windows <a
106+
href="https://github.com/code2k13/starrem2k13/releases/download/v2.1_win/starrem2k13_win.zip">here</a>.
107+
Simply unzip the downloaded zip archive and run the below command in command prompt:
108+
<br />
109+
<code lang="javascript">
97110
starrem2k13 image_with_stars.jpg starless.jpg
98111
</code>
99112

113+
</div>
100114
</div>
101115
</div>
102-
</div>
103-
<div class="accordion-item">
104-
<h2 class="accordion-header" id="headingTwo">
105-
<button class="accordion-button collapsed" type="button" data-bs-toggle="collapse"
106-
data-bs-target="#collapseTwo" aria-expanded="false" aria-controls="collapseTwo">
107-
Installing on Ubuntu 20.04 (and other Linux systems)
108-
</button>
109-
</h2>
110-
<div id="collapseTwo" class="accordion-collapse collapse" aria-labelledby="headingTwo"
111-
data-bs-parent="#accordionExample">
112-
<div class="accordion-body">
113-
Download the pre-built binaries for Linux <a href="https://github.com/code2k13/starrem2k13/releases/download/v2.0_linux/starrem2k13_ubuntu_20.04.tar.gz">here</a>.They have been tested with Ubuntu 20.04 and should work with other Linux distros. Execute the following commands:
114-
<br />
115-
<code>
116+
<div class="accordion-item">
117+
<h2 class="accordion-header" id="headingTwo">
118+
<button class="accordion-button collapsed" type="button" data-bs-toggle="collapse"
119+
data-bs-target="#collapseTwo" aria-expanded="false" aria-controls="collapseTwo">
120+
Installing on Ubuntu 20.04 (and other Linux systems)
121+
</button>
122+
</h2>
123+
<div id="collapseTwo" class="accordion-collapse collapse" aria-labelledby="headingTwo"
124+
data-bs-parent="#accordionExample">
125+
<div class="accordion-body">
126+
Download the pre-built binaries for Linux <a
127+
href="https://github.com/code2k13/starrem2k13/releases/download/v2.0_linux/starrem2k13_ubuntu_20.04.tar.gz">here</a>.They
128+
have been tested with Ubuntu 20.04 and should work with other Linux distros. Execute the
129+
following commands:
130+
<br />
131+
<code>
116132
tar -xvzf starrem2k13_ubuntu_20.04.tar.gz <br/>
117133
cd starrem2k13_ubuntu_20.04<br/>
118134
chmod +777 starrem2k13<br/>
119135
starrem2k13 image_with_stars.jpg starless.jpg<br/>
120136
</code>
137+
</div>
121138
</div>
122139
</div>
123-
</div>
124-
<div class="accordion-item">
125-
<h2 class="accordion-header" id="headingThree">
126-
<button class="accordion-button collapsed" type="button" data-bs-toggle="collapse"
127-
data-bs-target="#collapseThree" aria-expanded="false" aria-controls="collapseThree">
128-
Installation and running on MacOS
129-
</button>
130-
</h2>
131-
<div id="collapseThree" class="accordion-collapse collapse" aria-labelledby="headingThree"
132-
data-bs-parent="#accordionExample">
133-
<div class="accordion-body">
134-
Download the pre-built binary for MacOS <a href="https://github.com/code2k13/starrem2k13/releases/download/v2.0_macos/starrem2k13_macos_12.tar.gz">here</a>. The executable should work with most versions of MacOS. Unzip all the contents of the downloaded archive to a folder. Open Terminal, navigate to the
135-
folder and type the following command: <br />
136-
<code>
140+
<div class="accordion-item">
141+
<h2 class="accordion-header" id="headingThree">
142+
<button class="accordion-button collapsed" type="button" data-bs-toggle="collapse"
143+
data-bs-target="#collapseThree" aria-expanded="false" aria-controls="collapseThree">
144+
Installation and running on MacOS
145+
</button>
146+
</h2>
147+
<div id="collapseThree" class="accordion-collapse collapse" aria-labelledby="headingThree"
148+
data-bs-parent="#accordionExample">
149+
<div class="accordion-body">
150+
Download the pre-built binary for MacOS <a
151+
href="https://github.com/code2k13/starrem2k13/releases/download/v2.0_macos/starrem2k13_macos_12.tar.gz">here</a>.
152+
The executable should work with most versions of MacOS. Unzip all the contents of the
153+
downloaded archive to a folder. Open Terminal, navigate to the
154+
folder and type the following command: <br />
155+
<code>
137156
starrem2k13 image_with_stars.jpg starless.jpg
138157
</code>
139158

140159

160+
</div>
141161
</div>
142162
</div>
143-
</div>
144163

145-
<div class="accordion-item">
146-
<h2 class="accordion-header" id="headingFour">
147-
<button class="accordion-button collapsed" type="button" data-bs-toggle="collapse"
148-
data-bs-target="#collapseFour" aria-expanded="false" aria-controls="collapseFour">
149-
Running using Docker (works with all operating systems)
150-
</button>
151-
</h2>
152-
<div id="collapseFour" class="accordion-collapse collapse" aria-labelledby="headingFour"
153-
data-bs-parent="#accordionExample">
154-
<div class="accordion-body">
155-
Make sure you have docker installed and then execute : <br />
156-
<code>
164+
<div class="accordion-item">
165+
<h2 class="accordion-header" id="headingFour">
166+
<button class="accordion-button collapsed" type="button" data-bs-toggle="collapse"
167+
data-bs-target="#collapseFour" aria-expanded="false" aria-controls="collapseFour">
168+
Running using Docker (works with all operating systems)
169+
</button>
170+
</h2>
171+
<div id="collapseFour" class="accordion-collapse collapse" aria-labelledby="headingFour"
172+
data-bs-parent="#accordionExample">
173+
<div class="accordion-body">
174+
Make sure you have docker installed and then execute : <br />
175+
<code>
157176
docker run -v $PWD:/usr/src/app/starrem2k13/data \ <br/>
158177
-it code2k13/starrem2k13 \ <br/>
159178
/bin/bash -c "./starrem2k13.py ./data/example.jpg ./data/example_starless.jpg" <br/>
160179
</code>
161180

162-
<div>
163-
Note that $PWD refers to your current working directory. In the above example it is
164-
assumed that the file example.jpg resides in your current working directory. This
165-
directory is mounted as a volume with the path /usr/src/app/starreduction/data inside
166-
the docker container. The output image example_starless.jpg will also be written to same
167-
directory.
168-
</div>
181+
<div>
182+
Note that $PWD refers to your current working directory. In the above example it is
183+
assumed that the file example.jpg resides in your current working directory. This
184+
directory is mounted as a volume with the path /usr/src/app/starreduction/data
185+
inside
186+
the docker container. The output image example_starless.jpg will also be written to
187+
same
188+
directory.
189+
</div>
169190

170191

192+
</div>
171193
</div>
172194
</div>
173-
</div>
174195

196+
</div>
175197
</div>
176-
</div>
177198

178-
<h2 id="faq" class="mt-4">FAQ</h2>
199+
<h2 id="faq" class="mt-4">FAQ</h2>
179200

180-
<p>
181-
<span class="fw-bold">Where can I find source code for this tool?</span><br/>
182-
The source code is available here : <a href="https://github.com/code2k13/starrem2k13">https://github.com/code2k13/starrem2k13</a> </p>
201+
<p>
202+
<span class="fw-bold">Where can I find source code for this tool?</span><br />
203+
The source code is available here : <a
204+
href="https://github.com/code2k13/starrem2k13">https://github.com/code2k13/starrem2k13</a>
205+
</p>
183206

184-
<p></p><span class="fw-bold">Can I train my own model and use with this tool?</span><br/>
185-
Yes you can, please refer to this section : <a href="https://github.com/code2k13/starrem2k13#training-model-on-your-images">https://github.com/code2k13/starrem2k13#training-model-on-your-images</a></p>
207+
<p></p><span class="fw-bold">Can I train my own model and use with this tool?</span><br />
208+
Yes you can, please refer to this section : <a
209+
href="https://github.com/code2k13/starrem2k13#training-model-on-your-images">https://github.com/code2k13/starrem2k13#training-model-on-your-images</a>
210+
</p>
186211

187212

188-
<p><span class="fw-bold">I need help? </span><br/>
189-
You can reach out to me on Twitter <a href="https://twitter.com/patilsaheb">@patilsaheb</a></p>
213+
<p><span class="fw-bold">I need help? </span><br />
214+
You can reach out to me on Twitter <a href="https://twitter.com/patilsaheb">@patilsaheb</a></p>
190215

191-
<p><span class="fw-bold">Why is the startup of the program so slow ?</span><br/>
192-
I use <a href="https://pyinstaller.org/en/stable/">PyInstaller</a> to create executables from my Python scripts. This tool basically creates a bundle with python, required dependencies, my scripts and
193-
model weights. When it runs, it needs to unpackage everything , which takes time.</p>
216+
<p><span class="fw-bold">Why is the startup of the program so slow ?</span><br />
217+
I use <a href="https://pyinstaller.org/en/stable/">PyInstaller</a> to create executables from my Python
218+
scripts. This tool basically creates a bundle with python, required dependencies, my scripts and
219+
model weights. When it runs, it needs to unpackage everything , which takes time.</p>
194220

195221

196222

‎docs/starrem2k13_og.jpg‎

76.4 KB
Loading

0 commit comments

Comments
 (0)