Skip to content

Commit 7e16e31

Browse files
authored
Merge pull request #11769 from IQSS/11768-ood
Docs: add Open OnDemand/OnDemand Loop integration
2 parents 2ffeac4 + 1f74e8e commit 7e16e31

File tree

4 files changed

+28
-1
lines changed

4 files changed

+28
-1
lines changed

doc/release-notes/11768-ood.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
### Open OnDemand Integration
2+
3+
Open OnDemand, a web frontend to High Performance Computing (HPC) resources, has been integrated with Dataverse, allowing files to be downloaded from Dataverse installations around the world or from a specific dataset landing page if an external tool is enabled. Additionally, after computation is complete, datasets can be created in Dataverse from Open OnDemand and files can be uploaded. See the [docs](https://dataverse-guide--11769.org.readthedocs.build/en/11769/admin/integrations.html#open-ondemand), #11768 and #11769.

doc/sphinx-guides/source/_static/admin/dataverse-external-tools.tsv

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,3 +6,4 @@ Ask the Data query file Ask the Data is an experimental tool that allows you ask
66
TurboCurator by ICPSR configure dataset TurboCurator generates metadata improvements for title, description, and keywords. It relies on open AI's ChatGPT & ICPSR best practices. See the `TurboCurator Dataverse Administrator <https://turbocurator.icpsr.umich.edu/tc/adminabout/>`_ page for more details on how it works and adding TurboCurator to your Dataverse installation.
77
JupyterHub explore file The `Dataverse-to-JupyterHub Data Transfer Connector <https://forge.inrae.fr/dipso/eosc-pillar/dataverse-jupyterhub-connector>`_ is a tool that simplifies the transfer of data between Dataverse repositories and the cloud-based platform JupyterHub. It is designed for researchers, scientists, and data analysts, facilitating collaboration on projects by seamlessly moving datasets and files. The tool is a lightweight client-side web application built using React and relies on the Dataverse External Tool feature, allowing for easy deployment on modern integration systems. Currently optimized for small to medium-sized files, future plans include extending support for larger files and signed Dataverse endpoints. For more details, you can refer to the external tool manifest: https://forge.inrae.fr/dipso/eosc-pillar/dataverse-jupyterhub-connector/-/blob/master/externalTools.json
88
3DViewer by openforestdata.pl explore file The 3DViewer by openforestdata.pl can be used to explore 3D files (e.g. STL format). It was presented by Kamil Guryn during the 2020 community meeting (`slide deck <https://osf.io/aqgr5>`_, `video <https://youtu.be/YH4I_kldmGI?si=Y-9dZ3xPXeswchAl&t=2379>`_) and can be found at https://github.com/OpenForestData/open-forest-data-previewers
9+
Open OnDemand explore dataset Open OnDemand is a web frontend to High Performance Computing (HPC) resources that is integrated with Dataverse. See https://iqss.github.io/ondemand-loop/ for installation instructions.

doc/sphinx-guides/source/admin/integrations.rst

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -145,6 +145,12 @@ experience.
145145
.. _quickstart: https://docs.datalad.org/projects/dataverse/en/latest/settingup.html
146146
.. _tutorial: https://docs.datalad.org/projects/dataverse/en/latest/tutorial.html
147147

148+
.. _ood-upload:
149+
150+
Open OnDemand
151+
+++++++++++++
152+
153+
`Open OnDemand <https://openondemand.org>`_ is a web frontend to High Performance Computing (HPC) resources. Through a system called `OnDemand Loop <https://github.com/IQSS/ondemand-loop>`_, developed at IQSS, researchers can create datasets in Dataverse and upload files to them from their Open OnDemand installation. They can also :ref:`download <ood-download>` files from Dataverse.
148154

149155
Embedding Data on Websites
150156
--------------------------
@@ -220,6 +226,13 @@ Rclone
220226

221227
Rclone v1.70+ supports listing and downloading files from Dataverse datasets. For details, consult the Rclone `DOI remote <https://rclone.org/doi/>`_ documentation and the `discussion <https://groups.google.com/g/dataverse-community/c/IoxF85arJhA/m/QFD6vP-bBQAJ>`_ on the Dataverse mailing list.
222228

229+
.. _ood-download:
230+
231+
Open OnDemand
232+
+++++++++++++
233+
234+
`Open OnDemand <https://openondemand.org>`_ is a web frontend to High Performance Computing (HPC) resources. Through a system called `OnDemand Loop <https://github.com/IQSS/ondemand-loop>`_, developed at IQSS, researchers can click a button to explore a dataset (if the :doc:`external tool </admin/external-tools>` has been enabled) or discover and download datasets from Dataverse installations from around the world (and other data repositories) in their Open OnDemand computational environment. From that environment they can also :ref:`create datasets <ood-upload>` in Dataverse and upload files.
235+
223236
.. _integrations-discovery:
224237

225238
Discoverability

doc/sphinx-guides/source/api/apps.rst

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ Apps
33

44
The introduction of Dataverse Software APIs has fostered the development of a variety of software applications that are listed in the :doc:`/admin/integrations`, :doc:`/admin/external-tools`, and :doc:`/admin/reporting-tools-and-queries` sections of the Admin Guide.
55

6-
The apps below are open source and demonstrate how to use Dataverse Software APIs. Some of these apps are built on :doc:`/api/client-libraries` that are available for Dataverse Software APIs in Python, Javascript, R, and Java.
6+
The apps below are open source and demonstrate how to use Dataverse Software APIs. Some of these apps are built on :doc:`/api/client-libraries` that are available for Dataverse Software APIs in Python, Javascript, R, Java, and Ruby.
77

88
.. contents:: |toctitle|
99
:local:
@@ -165,3 +165,13 @@ OpenScholar
165165
The Dataverse Software module from OpenScholar allows a Dataverse installation's widgets to be easily embedded in its web pages:
166166

167167
https://github.com/openscholar/openscholar/tree/SCHOLAR-3.x/openscholar/modules/os_features/os_dataverse
168+
169+
Ruby
170+
----
171+
172+
Open OnDemand Loop
173+
~~~~~~~~~~~~~~~~~~
174+
175+
Open OnDemand Loop integrates Dataverse with Open OnDemand, as :ref:`described <ood-upload>` in the Admin Guide.
176+
177+
https://github.com/IQSS/ondemand-loop

0 commit comments

Comments
 (0)