Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Metadata Updates for New Release #90

Merged
merged 1 commit into from
Jun 6, 2024
Merged

Metadata Updates for New Release #90

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion cybergis_compute_client/CyberGISCompute.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ class CyberGISCompute:

job = None

def __init__(self, url="cgjobsup.cigi.illinois.edu", port=443, protocol='HTTPS', suffix="", isJupyter=True):
def __init__(self, url="cgjobsup.cigi.illinois.edu", port=443, protocol='HTTPS', suffix="v2", isJupyter=True):
"""
Initializes instance CyberGISCompute using inputs from the client

Expand Down
31 changes: 16 additions & 15 deletions docs/about.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
About
=====

Check out our latest paper on CyberGIS-Compute in `SoftwareX <https://doi.org/10.1016/j.softx.2024.101691>`_.

What is CyberGIS-Compute?
-------------------------

Expand Down Expand Up @@ -50,19 +52,18 @@ Citing
Below is an example reference for CyberGIS-Compute and bibtex entry::


@inproceedings{10.1145/3486189.3490017,
author = {Padmanabhan, Anand and Ziao, Ximo and Vandewalle, Rebecca C. and Baig, Furqan and Michel, Alexander and Li, Zhiyu and Wang, Shaowen},
title = {CyberGIS-Compute for Enabling Computationally Intensive Geospatial Research},
year = {2021},
isbn = {9781450391030},
publisher = {Association for Computing Machinery},
address = {New York, NY, USA},
url = {https://doi.org/10.1145/3486189.3490017},
doi = {10.1145/3486189.3490017},
booktitle = {Proceedings of the 3rd ACM SIGSPATIAL International Workshop on APIs and Libraries for Geospatial Data Science},
articleno = {3},
numpages = {2},
keywords = {CyberGIS, CyberGIS-Jupyter, GIScience, high performance computing},
location = {Beijing, China},
series = {SpatialAPI '21}
@article{michels_cybergis-compute_2024,
title = {{{CyberGIS-Compute}}: {{Middleware}} for Democratizing Scalable Geocomputation},
shorttitle = {{{CyberGIS-Compute}}},
author = {Michels, Alexander C. and Padmanabhan, Anand and Xiao, Zimo and Kotak, Mit and Baig, Furqan and Wang, Shaowen},
year = {2024},
month = may,
journal = {SoftwareX},
volume = {26},
pages = {101691},
issn = {2352-7110},
doi = {10.1016/j.softx.2024.101691},
copyright = {All rights reserved},
keywords = {CyberGIS,High-performance computing,Middleware,Scientific workflow}
}

4 changes: 2 additions & 2 deletions docs/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,11 +17,11 @@

# -- Project information -----------------------------------------------------
project = 'CyberGIS-Compute Python SDK'
copyright = '2022, CyberGIS Center'
copyright = '2024, CyberGIS Center'
author = 'CyberGIS Center'

# The full version, including alpha/beta/rc tags
release = 'v0.2.5'
release = 'v0.2.6'


# -- General configuration ---------------------------------------------------
Expand Down
105 changes: 2 additions & 103 deletions docs/release-notes.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,109 +3,8 @@ Release Notes

Release notes for the CyberGISX platform can be found here: `https://cybergisxhub.cigi.illinois.edu/release-notes/ <https://cybergisxhub.cigi.illinois.edu/release-notes/>`_

For details and full changelogs, check out the releases on Github: `https://github.com/cybergis/cybergis-compute-python-sdk/releases <https://github.com/cybergis/cybergis-compute-python-sdk/releases>`_
**CyberGIS-Compute SDK:** details and full changelogs, check out the releases on Github: `https://github.com/cybergis/cybergis-compute-python-sdk/releases <https://github.com/cybergis/cybergis-compute-python-sdk/releases>`_

[v0.2.5] - 2023-08-02
---------------------
**CyberGIS-Compute Core:** details and full changelogs, check out the releases on Github: `https://github.com/cybergis/cybergis-compute-core/releases <https://github.com/cybergis/cybergis-compute-core/releases>`_

Added
^^^^^

* Added an announcements section to the GUI in `#65 <https://github.com/cybergis/cybergis-compute-python-sdk/pull/65>`_
* Catching the Core's new HPC access denied exception in `#68 <https://github.com/cybergis/cybergis-compute-python-sdk/pull/68>`_
* Added the username to the GUI in `#70 <https://github.com/cybergis/cybergis-compute-python-sdk/pull/70>`_


[v0.2.4] - 2023-03-02
---------------------

Added
^^^^^

* Allow users to name folders in the UI in `#62 <https://github.com/cybergis/cybergis-compute-python-sdk/pull/62>`_

Updated
^^^^^^^

* Minor Fixes to Site and Docstrings in `#59 <https://github.com/cybergis/cybergis-compute-python-sdk/pull/59>`_
* update JSON login to avoid silent fails, confusing errors in `#61 <https://github.com/cybergis/cybergis-compute-python-sdk/pull/61>`_
* Updated tests and fixed bug in Zip.py in `#63 <https://github.com/cybergis/cybergis-compute-python-sdk/pull/63>`_


[v0.2.3] - 2022-10-06
---------------------

Added
^^^^^

* "Past Results" Tab with download buttons `#37 <https://github.com/cybergis/cybergis-compute-python-sdk/pull/37>`_
* ``list_jupyter_host()`` functionality to see the Core whitelist `#55 <https://github.com/cybergis/cybergis-compute-python-sdk/pull/55>`_

Updated
^^^^^^^

* Fix for broken ``list_job()`` function `#51 <https://github.com/cybergis/cybergis-compute-python-sdk/pull/51>`_
* Fix for "error displaying widget: model not found" when using --force-install without --no-deps `#57 <https://github.com/cybergis/cybergis-compute-python-sdk/pull/57>`_
* Minor UI bug fixes and QOL changes `#54 <https://github.com/cybergis/cybergis-compute-python-sdk/pull/54>`_

[v0.2.2] - 2022-09-08
---------------------

Added
^^^^^

* Released on PyPi! `https://pypi.org/project/cybergis-compute-client/ <https://pypi.org/project/cybergis-compute-client/>`_
* Added ``input_params`` argument to ``show_ui`` to allow users to programmatically pass in model specific parameters.

Updated
^^^^^^^

* Minor tweaks and fixes to the UI

Removed
^^^^^^^

* Removed some unnecessary files (``RIF_UI_NBK/``, ``example_output/``, and ``spatial_accessibility.ipynb``).


[v2.1] - 2022-08-15
-------------------

Added
^^^^^

* Adds remote folders, more work needed to integrate them into the UI and documentation on their use.

Updated
^^^^^^^

* Small changes to our Jupyter-based authentication (closes `#27 <https://github.com/cybergis/cybergis-compute-python-sdk/issues/27>`_)
* Small bug fixes to the UI.

Removed
^^^^^^^

* Removed the Job Access Token (JAT) authentication method

[2.0] - 2022-07-25
------------------

Added
^^^^^

* Added user interface (UI) using Jupyter widgets.
* Added Jupyter-based authentication, using both Job Access Token (JAT) and Jupyter.
* Released public webpage for documentation: `https://cybergis.github.io/cybergis-compute-python-sdk/ <https://cybergis.github.io/cybergis-compute-python-sdk/>`_
* Added a "Your Jobs" tab and "Refresh" button to restore jobs after the UI dies (closes `#15 <https://github.com/cybergis/cybergis-compute-python-sdk/issues/15>`_ and `#16 <https://github.com/cybergis/cybergis-compute-python-sdk/issues/16>`_).

Updated
^^^^^^^

* Named changed from ``job_supervisor_client`` to ``cybergis_compute_client``.
* Verified to be working on JupyterLab (closes `#6 <https://github.com/cybergis/cybergis-compute-python-sdk/issues/6>`_).


[v1] - 2021-10-26
-----------------

This version is on the branch v1: https://github.com/cybergis/cybergis-compute-python-sdk/tree/v1. The current deployment has been substantially reworked.
Loading
Loading