feat(docs): add readme with oscur.org style
Browse files
README.md
CHANGED
@@ -1,13 +1,209 @@
|
|
1 |
-
---
|
2 |
-
title: README
|
3 |
-
emoji:
|
4 |
-
colorFrom:
|
5 |
-
colorTo:
|
6 |
-
sdk: static
|
7 |
-
pinned:
|
8 |
-
|
9 |
-
|
10 |
-
|
11 |
-
|
12 |
-
|
13 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
---
|
2 |
+
title: README
|
3 |
+
emoji: 🌍
|
4 |
+
colorFrom: blue
|
5 |
+
colorTo: green
|
6 |
+
sdk: static
|
7 |
+
pinned: true
|
8 |
+
license: mit
|
9 |
+
---
|
10 |
+
|
11 |
+
<style>
|
12 |
+
.grid {
|
13 |
+
display: grid;
|
14 |
+
}
|
15 |
+
.lg\:grid-cols-2 {
|
16 |
+
grid-template-columns: repeat(2, 1fr);
|
17 |
+
}
|
18 |
+
.lg\:grid-cols-3 {
|
19 |
+
grid-template-columns: repeat(3, 1fr);
|
20 |
+
}
|
21 |
+
.gap-4 {
|
22 |
+
gap: 1rem;
|
23 |
+
}
|
24 |
+
.alert {
|
25 |
+
padding: 1rem;
|
26 |
+
border-radius: 0.5rem;
|
27 |
+
margin: 1rem 0;
|
28 |
+
}
|
29 |
+
.alert-info {
|
30 |
+
background-color: #e7f3fe;
|
31 |
+
border: 1px solid #b3d4fc;
|
32 |
+
}
|
33 |
+
.alert-important {
|
34 |
+
background-color: #fff3e0;
|
35 |
+
border: 1px solid #ffcc80;
|
36 |
+
}
|
37 |
+
.feature-icon {
|
38 |
+
width: 1.5em;
|
39 |
+
height: 1.5em;
|
40 |
+
vertical-align: middle;
|
41 |
+
margin-right: 0.5rem;
|
42 |
+
}
|
43 |
+
.centered {
|
44 |
+
display: flex;
|
45 |
+
justify-content: center;
|
46 |
+
align-items: center;
|
47 |
+
height: 100%;
|
48 |
+
}
|
49 |
+
|
50 |
+
.quotes-title {
|
51 |
+
text-align: center;
|
52 |
+
color: #666;
|
53 |
+
font-size: 0.9em;
|
54 |
+
font-weight: bold;
|
55 |
+
font-family: Georgia,Times,Times New Roman,serif;
|
56 |
+
}
|
57 |
+
.quote-column {
|
58 |
+
display: flex;
|
59 |
+
flex-direction: column;
|
60 |
+
justify-content: center;
|
61 |
+
}
|
62 |
+
|
63 |
+
.feature-icon {
|
64 |
+
width: 1.5em;
|
65 |
+
height: 1.5em;
|
66 |
+
vertical-align: middle;
|
67 |
+
margin-right: 0.5rem;
|
68 |
+
}
|
69 |
+
|
70 |
+
.title-icon {
|
71 |
+
margin-top: -3rem;
|
72 |
+
}
|
73 |
+
</style>
|
74 |
+
|
75 |
+
<div class="grid lg:grid-cols-2 gap-4">
|
76 |
+
<div class="col-span-1 centered">
|
77 |
+
<img src="https://huggingface.co/spaces/oscur/README/resolve/main/OSCUR_vision.png" alt="OSCUR Logo" style="max-height: 450px; width: auto;">
|
78 |
+
</div>
|
79 |
+
<div class="col-span-1 centered">
|
80 |
+
<div style="margin-top: 50px">
|
81 |
+
<h1>OSCUR: Open-Source Cyberinfrastructure for Urban Computing</h1>
|
82 |
+
<p><strong>OSCUR</strong> is transforming urban computing by making complex city data accessible and actionable through open-source tools. Funded by a $5M National Science Foundation grant, we empower researchers, city planners, and communities to tackle urban challenges like transportation, climate change, and environmental justice.</p>
|
83 |
+
<h3><img src="https://www.svgrepo.com/show/488665/quote-left.svg" class="feature-icon col-span-2 quotes-title" style="display: inline; vertical-align: middle;"> They Say It Best...</h3>
|
84 |
+
<div class="grid lg:grid-cols-2 gap-4" style="margin-top: -3em;">
|
85 |
+
<div class="col-span-1 quote-column">
|
86 |
+
<blockquote>
|
87 |
+
"While open data is increasingly available across a host of urban areas - from resource consumption to housing and infrastructure — its potential remains largely untapped because of unique challenges related to the diversity and scale of the data and the complex computations required to obtain trustworthy insights."
|
88 |
+
<footer>— <a href="https://engineering.nyu.edu/faculty/claudio-silva" target="_blank">Claudio Silva</a>, NYU Tandon School of Engineering</footer>
|
89 |
+
</blockquote>
|
90 |
+
<blockquote>
|
91 |
+
"OSCUR empowers us to turn data into action for healthier cities."
|
92 |
+
<footer>— <a href="https://cs.uic.edu/profiles/miranda-fabio/" target="_blank">Fabio Miranda</a>, University of Illinois Chicago</footer>
|
93 |
+
</blockquote>
|
94 |
+
</div>
|
95 |
+
<div class="col-span-1 quote-column">
|
96 |
+
<blockquote>
|
97 |
+
"With OSCUR, we're trying to democratize urban computing and empower a broad range of stakeholders to analyze urban data at scale."
|
98 |
+
<footer>— <a href="https://engineering.nyu.edu/faculty/juliana-freire" target="_blank">Juliana Freire</a>, NYU Tandon School of Engineering</footer>
|
99 |
+
</blockquote>
|
100 |
+
<blockquote>
|
101 |
+
"The true beauty and promise of OSCUR is in how it attempts to unify long-standing and deeply interconnected problems in urban science that often have disparate approaches spread across disciplines."
|
102 |
+
<footer>— <a href="https://www.cs.washington.edu/people/faculty/jon-e-froehlich/" target="_blank">Jon E. Froehlich</a>, University of Washington</footer>
|
103 |
+
</blockquote>
|
104 |
+
</div>
|
105 |
+
</div>
|
106 |
+
</div>
|
107 |
+
</div>
|
108 |
+
</div>
|
109 |
+
|
110 |
+
<h1><span><img src="https://www.svgrepo.com/show/384267/360-vision-picture-image.svg" class="feature-icon" style="display: inline; vertical-align: middle; justify-content: center"> Vision</span></h1>
|
111 |
+
|
112 |
+
<div class="grid lg:grid-cols-2 gap-4 title-icon">
|
113 |
+
<div class="col-span-1">
|
114 |
+
<h3>We Aim to Revolutionize Urban Computing</h3>
|
115 |
+
<ul>
|
116 |
+
<li><strong>Foster Partnerships</strong>: Advance open and reproducible urban analytics through collaboration.</li>
|
117 |
+
<li><strong>Leverage NSF Initiatives</strong>: Harness the strengths of existing NSF-funded projects.</li>
|
118 |
+
<li><strong>Promote Civic & Global Programs</strong>: Support civic initiatives, research, and education worldwide.</li>
|
119 |
+
<li><strong>Democratize Urban Computing</strong>: Make analytics accessible to all globally.</li>
|
120 |
+
</ul>
|
121 |
+
</div>
|
122 |
+
<div class="col-span-1">
|
123 |
+
<h3>Outcomes</h3>
|
124 |
+
<ul>
|
125 |
+
<li>A novel open-source cyberinfrastructure for reproducible urban computing.</li>
|
126 |
+
<li>A cohesive and engaged urban computing community.</li>
|
127 |
+
<li>A path toward healthier, more resilient, accessible, and sustainable cities.</li>
|
128 |
+
</ul>
|
129 |
+
</div>
|
130 |
+
</div>
|
131 |
+
|
132 |
+
<h1><span><img src="https://www.svgrepo.com/show/470665/objects-on-phone.svg" class="feature-icon" style="display: inline; vertical-align: middle;"> Key Features</span></h1>
|
133 |
+
|
134 |
+
<div class="title-icon" style="text-align: center; margin: 1rem 0;">
|
135 |
+
<img src="https://huggingface.co/spaces/oscur/README/resolve/main/Catalyzing_Urban_Computing_Community_Through_Shared_Cyberinfrastructure.png" alt="OSCUR Features" style="width: 60%; display: block; margin: 0 auto;">
|
136 |
+
<p style="font-size: 1.1em; font-weight: bold; margin-top: 0.5rem;">Unlock the Power of Urban Data</p>
|
137 |
+
</div>
|
138 |
+
|
139 |
+
<div class="alert alert-success" style="text-align: center;">
|
140 |
+
<strong to Learn More?</strong> Explore OSCUR’s potential at <a href="https://oscur.org/" target="_blank">oscur.org</a> and join the urban computing community!
|
141 |
+
</div>
|
142 |
+
|
143 |
+
|
144 |
+
<h1><span><img src="https://www.svgrepo.com/show/374627/dataset.svg" class="feature-icon" style="display: inline; vertical-align: middle;"> Datasets</span></h1>
|
145 |
+
|
146 |
+
<p class="title-icon" style="font-weight: normal;">
|
147 |
+
|
148 |
+
Through all research outputs by <code>OSCUR</code>, datasets will be used, while as much as possible striving for open-data.
|
149 |
+
Therefore, to make it easier, we host below a list of open-datasets for <code>OSCUR</code> users to more rapidly access and analyse via the
|
150 |
+
<code>Hugging Face Datasets</code> library.
|
151 |
+
|
152 |
+
To name a few, this will be including urban tabular datasets, annotated visual data, sensor readings, human behavior markers,
|
153 |
+
and other structured data tailored for urban computing scenarios. Each dataset is formatted for direct integration into machine learning workflows and visual
|
154 |
+
analytics pipelines, supporting applied research and education.
|
155 |
+
|
156 |
+
</p>
|
157 |
+
|
158 |
+
<div class="alert alert-info">
|
159 |
+
<p><strong>Note:</strong> Access our curated datasets with ease! For example, to load NYC Taxi Vis is the <code>taxisvis1M</code> dataset, use the following code:</p>
|
160 |
+
<pre><code>from datasets import load_dataset
|
161 |
+
dataset = load_dataset("OSCUR/taxisvis1M")</code></pre>
|
162 |
+
<p>Simply replace <code>taxisvis1M</code> with other dataset names to explore additional datasets. Here are some examples:</p>
|
163 |
+
<ul>
|
164 |
+
<li><strong><a href="https://huggingface.co/datasets/oscur/taxisvis1M" target="_blank">NYC Taxi –– <code>taxisvis1M</code> </a></strong>: Public New York City taxi pickup and drop-off datasets.</li>
|
165 |
+
<li><strong><a href="https://huggingface.co/datasets/oscur/NYC_311" target="_blank">NYC Service Requests –– <code>NYC_311</code> </a></strong>: 311 Service on-street Requests from 2010 to present in New York City datasets.</li>
|
166 |
+
<li><strong><a href="https://huggingface.co/datasets/oscur/pluto" target="_blank">NYC Buildings Information –– <code>pluto</code> </a></strong>: The Primary Land Use Tax Lot Output (PLUTO™) containing extensive land use and geographic data at the tax lot level in NYC.</li>
|
167 |
+
</ul>
|
168 |
+
</div>
|
169 |
+
|
170 |
+
<h1><span><img src="https://www.svgrepo.com/show/347241/open-source.svg" class="feature-icon" style="display: inline; vertical-align: middle;"> Libraries in the OSCUR Ecosystem</span></h1>
|
171 |
+
|
172 |
+
<p class="title-icon" style="font-weight: normal;">Explore the tools powering <code>OSCUR</code>:</p>
|
173 |
+
|
174 |
+
<div class="grid lg:grid-cols-2 gap-4 title-icon">
|
175 |
+
<div class="col-span-1">
|
176 |
+
<h3><img src="https://www.svgrepo.com/show/511725/collection-989.svg" class="feature-icon" style="display: inline; vertical-align: middle;"> Data Collection & Discovery</h3>
|
177 |
+
<p class="title-icon" style="font-weight: normal;">Scrape and collect urban data from diverse sources.</p>
|
178 |
+
<ul class="">
|
179 |
+
<li style="font-weight: normal;" >🍳 No libraries yet, but we’re cooking something great!</li>
|
180 |
+
</ul>
|
181 |
+
</div>
|
182 |
+
<div class="col-span-1">
|
183 |
+
<h3><img src="https://www.svgrepo.com/show/172736/transformation-of-geometric-shapes-from-cube-to-cone-outlines.svg" class="feature-icon" style="display: inline; vertical-align: middle;"> Curation & Transformation</h3>
|
184 |
+
<p class="title-icon" style="font-weight: normal;">Pre Process & Transform machine-learning-ready urban datasets.</p>
|
185 |
+
<ul class="">
|
186 |
+
<li style="font-weight: normal;" >🍳 No libraries yet, but we’re cooking something great!</li>
|
187 |
+
</ul>
|
188 |
+
</div>
|
189 |
+
<div class="col-span-1">
|
190 |
+
<h3><img src="https://www.svgrepo.com/show/340628/machine-learning-model.svg" class="feature-icon" style="display: inline; vertical-align: middle;"> Analytics & Modelling</h3>
|
191 |
+
<p class="title-icon" style="font-weight: normal;">Perform advanced analytics and machine learning on urban datasets.</p>
|
192 |
+
<ul class="">
|
193 |
+
<li style="font-weight: normal;" ><a href="https://github.com/VIDA-NYU/UrbanMapper" target="_blank">UrbanMapper</a> – Augment & Enrich plain <code>urban layers</code> using <code>urban datasets</code>' basic to ML-powered and LLM- statistics and aggregations using a <code>Scikit-Learn-like</code> urban pipeline!</li>
|
194 |
+
</ul>
|
195 |
+
</div>
|
196 |
+
<div class="col-span-1">
|
197 |
+
<h3><img src="https://www.svgrepo.com/show/340628/machine-learning-model.svg" class="feature-icon" style="display: inline; vertical-align: middle;"> Visualization</h3>
|
198 |
+
<p class="title-icon" style="font-weight: normal;">Create interactive visualizations for urban insights.</p>
|
199 |
+
<ul class="">
|
200 |
+
<li style="font-weight: normal;" >🍳 No libraries yet, but we’re cooking something great!</li>
|
201 |
+
</ul>
|
202 |
+
</div>
|
203 |
+
</div>
|
204 |
+
|
205 |
+
Let’s build smarter cities together! 🌟
|
206 |
+
|
207 |
+
Cheers,
|
208 |
+
|
209 |
+
@OSCUR team
|