Skip to content

Commit 0fadd28

Browse files
committed
Update private recipe page
1 parent cf24916 commit 0fadd28

3 files changed

Lines changed: 23 additions & 23 deletions

File tree

_sources/private_recipes.rst.txt

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ for more information on the :code:`ggd check-recipe` command see :ref:`ggd check
6363
.. note::
6464

6565
Installing private data recipes will take longer because the recipe goes through the normal check and validation step before it is
66-
installed. Additionally, there is now way to cache private data recipes, so the speedup seen from installing public data recipes is
66+
installed. Additionally, there is no way to cache private data recipes, so the speedup seen from installing public data recipes is
6767
not available.
6868

6969

@@ -75,7 +75,7 @@ Now that the data recipe has been created, it has been checked, and installed, y
7575

7676
.. note::
7777

78-
We are suggesting adding the *data recipe* not the actual data to the private github repository
78+
We are suggesting adding the *data recipe*, not the actual data to the private github repository
7979

8080

8181

@@ -104,7 +104,7 @@ C. Listing installed private recipes
104104

105105
:code:`ggd list` has a :code:`--prefix` argument that is used to list installed data recipes in different
106106
conda environments. The :code:`--prefix` argument **can** be used for private recipes. This means you can list
107-
private data recipes that are installed in a different conda environment then the currently active environment
107+
private data recipes that are installed in a different conda environment than the currently active environment
108108
you are using.
109109

110110
For more information about the :code:`ggd list` command see: :ref:`ggd-list`
@@ -117,7 +117,7 @@ D. Getting data files for private recipes
117117

118118
:code:`ggd get-files` has a :code:`--prefix` argument that is used to get installed data files from different conda environments.
119119
This :code:`--prefix` argument **can** be used for private recipes. This means you can get installed data files from private recipes
120-
that are in a different conda environment then the currently active one.
120+
that are in a different conda environment than the currently active one.
121121

122122
For more information about the :code:`ggd get-files` command see: :ref:`ggd-get-files`
123123

@@ -144,20 +144,20 @@ data recipe.
144144

145145
.. note::
146146

147-
The :code:`-du` argument is absent from the :code:`ggd check-recipe` command.
147+
To uninstall the private data recipe you must omit the :code:`-du` argument from the :code:`ggd check-recipe` command.
148148

149149

150150

151151
Finally
152152
-------
153153

154-
GGD is a data management system built to mange and distribute publicly available scientific data. As this is the main purpose of GGD we encourage
154+
GGD is a data management system built to manage and distribute publicly available scientific data. As this is the main purpose of GGD we encourage
155155
user to add ggd recipes to the public ggd repositories for the scientific community to use. GGD is built to help remove the inconsistencies with
156-
data processing and management that has plagued researchers for year. Therefore, GGD will continue to encourage public data access, management, and
157-
reproducibility. We understand that sometimes data cannot be shared publicly, but that the convenience and power of GGD can assist researchers and
158-
scientist during an analysis. The features on this page are here to assist if you want to use GGD but truly need to retain data privacy.
159-
However, GGD will continue to promote public data sharing whenever possible, and therefore, the GGD features will be maintained to support such
160-
goals.
156+
data processing and management that have plagued researchers for year. Therefore, GGD will continue to encourage public data access, management, and
157+
reproducibility. We understand that sometimes data cannot be shared publicly, but a user may wish to use GGD to process and manage their data, as well
158+
as to use the infrastructure of data recipes for reproducibility. The features on this page are here to assist if you want to use GGD but truly need
159+
to retain data privacy. However, GGD will continue to promote public data sharing whenever possible, and therefore, the GGD features will be maintained
160+
to support such goals.
161161

162162

163163

private_recipes.html

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -143,7 +143,7 @@ <h2>3. Check and install the data recipe<a class="headerlink" href="#check-and-i
143143
<div class="admonition note">
144144
<p class="admonition-title">Note</p>
145145
<p>Installing private data recipes will take longer because the recipe goes through the normal check and validation step before it is
146-
installed. Additionally, there is now way to cache private data recipes, so the speedup seen from installing public data recipes is
146+
installed. Additionally, there is no way to cache private data recipes, so the speedup seen from installing public data recipes is
147147
not available.</p>
148148
</div>
149149
</div>
@@ -152,7 +152,7 @@ <h2>4. Add the data recipe to github<a class="headerlink" href="#add-the-data-re
152152
<p>Now that the data recipe has been created, it has been checked, and installed, you can add it to your private github repository.</p>
153153
<div class="admonition note">
154154
<p class="admonition-title">Note</p>
155-
<p>We are suggesting adding the <em>data recipe</em> not the actual data to the private github repository</p>
155+
<p>We are suggesting adding the <em>data recipe</em>, not the actual data to the private github repository</p>
156156
</div>
157157
</div>
158158
<div class="section" id="how-to-access-installed-data-from-private-recipe">
@@ -179,7 +179,7 @@ <h2>5. How to access installed data from private recipe<a class="headerlink" hre
179179
<p class="admonition-title">Note</p>
180180
<p><code class="code docutils literal notranslate"><span class="pre">ggd</span> <span class="pre">list</span></code> has a <code class="code docutils literal notranslate"><span class="pre">--prefix</span></code> argument that is used to list installed data recipes in different
181181
conda environments. The <code class="code docutils literal notranslate"><span class="pre">--prefix</span></code> argument <strong>can</strong> be used for private recipes. This means you can list
182-
private data recipes that are installed in a different conda environment then the currently active environment
182+
private data recipes that are installed in a different conda environment than the currently active environment
183183
you are using.</p>
184184
</div>
185185
<p>For more information about the <code class="code docutils literal notranslate"><span class="pre">ggd</span> <span class="pre">list</span></code> command see: <a class="reference internal" href="list.html#ggd-list"><span class="std std-ref">ggd list</span></a></p>
@@ -192,7 +192,7 @@ <h2>5. How to access installed data from private recipe<a class="headerlink" hre
192192
<p class="admonition-title">Note</p>
193193
<p><code class="code docutils literal notranslate"><span class="pre">ggd</span> <span class="pre">get-files</span></code> has a <code class="code docutils literal notranslate"><span class="pre">--prefix</span></code> argument that is used to get installed data files from different conda environments.
194194
This <code class="code docutils literal notranslate"><span class="pre">--prefix</span></code> argument <strong>can</strong> be used for private recipes. This means you can get installed data files from private recipes
195-
that are in a different conda environment then the currently active one.</p>
195+
that are in a different conda environment than the currently active one.</p>
196196
</div>
197197
<p>For more information about the <code class="code docutils literal notranslate"><span class="pre">ggd</span> <span class="pre">get-files</span></code> command see: <a class="reference internal" href="list-file.html#ggd-get-files"><span class="std std-ref">ggd get-files</span></a></p>
198198
</div></blockquote>
@@ -217,18 +217,18 @@ <h2>7. Uninstalling a previously installed private data recipe<a class="headerli
217217
data recipe.</p>
218218
<div class="admonition note">
219219
<p class="admonition-title">Note</p>
220-
<p>The <code class="code docutils literal notranslate"><span class="pre">-du</span></code> argument is absent from the <code class="code docutils literal notranslate"><span class="pre">ggd</span> <span class="pre">check-recipe</span></code> command.</p>
220+
<p>To uninstall the private data recipe you must omit the <code class="code docutils literal notranslate"><span class="pre">-du</span></code> argument from the <code class="code docutils literal notranslate"><span class="pre">ggd</span> <span class="pre">check-recipe</span></code> command.</p>
221221
</div>
222222
</div>
223223
<div class="section" id="finally">
224224
<h2>Finally<a class="headerlink" href="#finally" title="Permalink to this headline"></a></h2>
225-
<p>GGD is a data management system built to mange and distribute publicly available scientific data. As this is the main purpose of GGD we encourage
225+
<p>GGD is a data management system built to manage and distribute publicly available scientific data. As this is the main purpose of GGD we encourage
226226
user to add ggd recipes to the public ggd repositories for the scientific community to use. GGD is built to help remove the inconsistencies with
227-
data processing and management that has plagued researchers for year. Therefore, GGD will continue to encourage public data access, management, and
228-
reproducibility. We understand that sometimes data cannot be shared publicly, but that the convenience and power of GGD can assist researchers and
229-
scientist during an analysis. The features on this page are here to assist if you want to use GGD but truly need to retain data privacy.
230-
However, GGD will continue to promote public data sharing whenever possible, and therefore, the GGD features will be maintained to support such
231-
goals.</p>
227+
data processing and management that have plagued researchers for year. Therefore, GGD will continue to encourage public data access, management, and
228+
reproducibility. We understand that sometimes data cannot be shared publicly, but a user may wish to use GGD to process and manage their data, as well
229+
as to use the infrastructure of data recipes for reproducibility. The features on this page are here to assist if you want to use GGD but truly need
230+
to retain data privacy. However, GGD will continue to promote public data sharing whenever possible, and therefore, the GGD features will be maintained
231+
to support such goals.</p>
232232
</div>
233233
</div>
234234

searchindex.js

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)