Skip to content

Commit 69f245c

Browse files
mkcormkcor
committed
Add tutorial by @alexdesiqueira for Data Umbrella
1 parent be34fdb commit 69f245c

File tree

6 files changed

+2133
-0
lines changed

6 files changed

+2133
-0
lines changed

‎workshops/2022-data-umbrella/2022_10-skimage_data_umbrella.ipynb

+1,700
Large diffs are not rendered by default.

‎workshops/2022-data-umbrella/LICENSE

+121
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,121 @@
1+
Creative Commons Legal Code
2+
3+
CC0 1.0 Universal
4+
5+
CREATIVE COMMONS CORPORATION IS NOT A LAW FIRM AND DOES NOT PROVIDE
6+
LEGAL SERVICES. DISTRIBUTION OF THIS DOCUMENT DOES NOT CREATE AN
7+
ATTORNEY-CLIENT RELATIONSHIP. CREATIVE COMMONS PROVIDES THIS
8+
INFORMATION ON AN "AS-IS" BASIS. CREATIVE COMMONS MAKES NO WARRANTIES
9+
REGARDING THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS
10+
PROVIDED HEREUNDER, AND DISCLAIMS LIABILITY FOR DAMAGES RESULTING FROM
11+
THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS PROVIDED
12+
HEREUNDER.
13+
14+
Statement of Purpose
15+
16+
The laws of most jurisdictions throughout the world automatically confer
17+
exclusive Copyright and Related Rights (defined below) upon the creator
18+
and subsequent owner(s) (each and all, an "owner") of an original work of
19+
authorship and/or a database (each, a "Work").
20+
21+
Certain owners wish to permanently relinquish those rights to a Work for
22+
the purpose of contributing to a commons of creative, cultural and
23+
scientific works ("Commons") that the public can reliably and without fear
24+
of later claims of infringement build upon, modify, incorporate in other
25+
works, reuse and redistribute as freely as possible in any form whatsoever
26+
and for any purposes, including without limitation commercial purposes.
27+
These owners may contribute to the Commons to promote the ideal of a free
28+
culture and the further production of creative, cultural and scientific
29+
works, or to gain reputation or greater distribution for their Work in
30+
part through the use and efforts of others.
31+
32+
For these and/or other purposes and motivations, and without any
33+
expectation of additional consideration or compensation, the person
34+
associating CC0 with a Work (the "Affirmer"), to the extent that he or she
35+
is an owner of Copyright and Related Rights in the Work, voluntarily
36+
elects to apply CC0 to the Work and publicly distribute the Work under its
37+
terms, with knowledge of his or her Copyright and Related Rights in the
38+
Work and the meaning and intended legal effect of CC0 on those rights.
39+
40+
1. Copyright and Related Rights. A Work made available under CC0 may be
41+
protected by copyright and related or neighboring rights ("Copyright and
42+
Related Rights"). Copyright and Related Rights include, but are not
43+
limited to, the following:
44+
45+
i. the right to reproduce, adapt, distribute, perform, display,
46+
communicate, and translate a Work;
47+
ii. moral rights retained by the original author(s) and/or performer(s);
48+
iii. publicity and privacy rights pertaining to a person's image or
49+
likeness depicted in a Work;
50+
iv. rights protecting against unfair competition in regards to a Work,
51+
subject to the limitations in paragraph 4(a), below;
52+
v. rights protecting the extraction, dissemination, use and reuse of data
53+
in a Work;
54+
vi. database rights (such as those arising under Directive 96/9/EC of the
55+
European Parliament and of the Council of 11 March 1996 on the legal
56+
protection of databases, and under any national implementation
57+
thereof, including any amended or successor version of such
58+
directive); and
59+
vii. other similar, equivalent or corresponding rights throughout the
60+
world based on applicable law or treaty, and any national
61+
implementations thereof.
62+
63+
2. Waiver. To the greatest extent permitted by, but not in contravention
64+
of, applicable law, Affirmer hereby overtly, fully, permanently,
65+
irrevocably and unconditionally waives, abandons, and surrenders all of
66+
Affirmer's Copyright and Related Rights and associated claims and causes
67+
of action, whether now known or unknown (including existing as well as
68+
future claims and causes of action), in the Work (i) in all territories
69+
worldwide, (ii) for the maximum duration provided by applicable law or
70+
treaty (including future time extensions), (iii) in any current or future
71+
medium and for any number of copies, and (iv) for any purpose whatsoever,
72+
including without limitation commercial, advertising or promotional
73+
purposes (the "Waiver"). Affirmer makes the Waiver for the benefit of each
74+
member of the public at large and to the detriment of Affirmer's heirs and
75+
successors, fully intending that such Waiver shall not be subject to
76+
revocation, rescission, cancellation, termination, or any other legal or
77+
equitable action to disrupt the quiet enjoyment of the Work by the public
78+
as contemplated by Affirmer's express Statement of Purpose.
79+
80+
3. Public License Fallback. Should any part of the Waiver for any reason
81+
be judged legally invalid or ineffective under applicable law, then the
82+
Waiver shall be preserved to the maximum extent permitted taking into
83+
account Affirmer's express Statement of Purpose. In addition, to the
84+
extent the Waiver is so judged Affirmer hereby grants to each affected
85+
person a royalty-free, non transferable, non sublicensable, non exclusive,
86+
irrevocable and unconditional license to exercise Affirmer's Copyright and
87+
Related Rights in the Work (i) in all territories worldwide, (ii) for the
88+
maximum duration provided by applicable law or treaty (including future
89+
time extensions), (iii) in any current or future medium and for any number
90+
of copies, and (iv) for any purpose whatsoever, including without
91+
limitation commercial, advertising or promotional purposes (the
92+
"License"). The License shall be deemed effective as of the date CC0 was
93+
applied by Affirmer to the Work. Should any part of the License for any
94+
reason be judged legally invalid or ineffective under applicable law, such
95+
partial invalidity or ineffectiveness shall not invalidate the remainder
96+
of the License, and in such case Affirmer hereby affirms that he or she
97+
will not (i) exercise any of his or her remaining Copyright and Related
98+
Rights in the Work or (ii) assert any associated claims and causes of
99+
action with respect to the Work, in either case contrary to Affirmer's
100+
express Statement of Purpose.
101+
102+
4. Limitations and Disclaimers.
103+
104+
a. No trademark or patent rights held by Affirmer are waived, abandoned,
105+
surrendered, licensed or otherwise affected by this document.
106+
b. Affirmer offers the Work as-is and makes no representations or
107+
warranties of any kind concerning the Work, express, implied,
108+
statutory or otherwise, including without limitation warranties of
109+
title, merchantability, fitness for a particular purpose, non
110+
infringement, or the absence of latent or other defects, accuracy, or
111+
the present or absence of errors, whether or not discoverable, all to
112+
the greatest extent permissible under applicable law.
113+
c. Affirmer disclaims responsibility for clearing rights of other persons
114+
that may apply to the Work or any use thereof, including without
115+
limitation any person's Copyright and Related Rights in the Work.
116+
Further, Affirmer disclaims responsibility for obtaining any necessary
117+
consents, permissions or other rights required for any use of the
118+
Work.
119+
d. Affirmer understands and acknowledges that Creative Commons is not a
120+
party to this document and has no duty or obligation with respect to
121+
this CC0 or use of the Work.

‎workshops/2022-data-umbrella/check_setup.py

+72
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
1+
import sys
2+
from packaging.version import Version
3+
4+
EXIT_ERROR = 1
5+
PYTHON_VERSION_MAJOR = 3
6+
PYTHON_VERSION_MINOR = 8
7+
8+
9+
def check_python_version():
10+
if ((sys.version_info.major < PYTHON_VERSION_MAJOR) or
11+
(sys.version_info.minor < PYTHON_VERSION_MINOR)):
12+
print(f"[!] You are running an unsupported version of Python. "
13+
"This tutorial requires Python version "
14+
"{PYTHON_VERSION_MAJOR}.{PYTHON_VERSION_MINOR} or newer.")
15+
16+
sys.exit(EXIT_ERROR)
17+
return None
18+
19+
20+
def read_requirements(filename="requirements.txt"):
21+
with open(filename) as file_reqs:
22+
requirements = file_reqs.readlines()
23+
24+
requirements = [
25+
(package, version) for (package, _, version) in
26+
(requirement.split()
27+
for requirement in requirements if requirement.strip())
28+
]
29+
return requirements
30+
31+
32+
def check_setup():
33+
pkg_names = {
34+
"jupyter-notebook": "notebook",
35+
"scikit-image": "skimage",
36+
}
37+
38+
check_python_version()
39+
requirements = read_requirements()
40+
41+
for (package, version_required) in requirements:
42+
module_name = pkg_names.get(package, package)
43+
try:
44+
module = __import__(module_name)
45+
status = "✓"
46+
except ImportError as e:
47+
module = None
48+
if (package != "numpy" and "numpy" in str(e)):
49+
status = "?"
50+
version_installed = "Needs NumPy"
51+
else:
52+
version_installed = "Not installed"
53+
status = "X"
54+
55+
if module is not None:
56+
try:
57+
version_installed = module.__version__
58+
except AttributeError: # specific for ITK version
59+
version_installed = module.Version.GetITKVersion()
60+
61+
if Version(version_required) > Version(version_installed):
62+
status = "X"
63+
print("[{}] {:<10} {}".format(
64+
status, package.ljust(16), version_installed)
65+
)
66+
67+
68+
if __name__ == '__main__':
69+
try:
70+
check_setup()
71+
except ValueError: # avoiding error on matplotlib
72+
pass

‎workshops/2022-data-umbrella/environment.yml

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
name: dataumbrella_skimage
2+
channels:
3+
- conda-forge
4+
dependencies:
5+
- python >= 3
6+
- numpy == 1.22
7+
- scipy == 1.8
8+
- matplotlib == 3.5
9+
- scikit-image
10+
- notebook == 6.4
11+
- itk == 5.2
12+
- itkwidgets == 0.32

‎workshops/2022-data-umbrella/requirements.txt

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
numpy >= 1
2+
scipy >= 1
3+
matplotlib >= 2.0
4+
scikit-image >= 0.18
5+
notebook >= 4.0
6+
itk >= 5.0
7+
itkwidgets >= 0.30

0 commit comments

Comments
 (0)