-
Notifications
You must be signed in to change notification settings - Fork 6
/
Copy pathindex.html
174 lines (155 loc) · 10.9 KB
/
index.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Welcome to DimCli’s documentation! — DimCli documentation</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Getting Started with Dimcli" href="getting-started.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="#" class="icon icon-home"> DimCli
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<p class="caption" role="heading"><span class="caption-text">Contents</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="getting-started.html">Getting Started with Dimcli</a></li>
<li class="toctree-l1"><a class="reference internal" href="modules.html">Modules Reference</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="#">DimCli</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="#" class="icon icon-home"></a> »</li>
<li>Welcome to DimCli’s documentation!</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/index.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<section id="welcome-to-dimcli-s-documentation">
<h1>Welcome to DimCli’s documentation!<a class="headerlink" href="#welcome-to-dimcli-s-documentation" title="Permalink to this headline"></a></h1>
<p>Dimcli is a Python client for accessing the Dimensions Analytics API.</p>
<p>Dimcli lives on <a class="reference external" href="https://github.com/digital-science/dimcli/">Github</a>. Suggestions, pull requests and improvements welcome!</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="kn">import</span> <span class="nn">dimcli</span>
<span class="gp">>>> </span><span class="n">dimcli</span><span class="o">.</span><span class="n">login</span><span class="p">(</span><span class="n">key</span><span class="o">=</span><span class="s2">"private-key-here"</span><span class="p">,</span>
<span class="go"> endpoint="https://app.dimensions.ai/api/dsl/v2")</span>
<span class="gp">>>> </span><span class="n">dsl</span> <span class="o">=</span> <span class="n">dimcli</span><span class="o">.</span><span class="n">Dsl</span><span class="p">()</span>
<span class="gp">>>> </span><span class="n">res</span> <span class="o">=</span> <span class="n">dsl</span><span class="o">.</span><span class="n">query</span><span class="p">(</span><span class="s2">"""search grants for "malaria" return researchers"""</span><span class="p">)</span>
<span class="gp">>>> </span><span class="nb">print</span><span class="p">(</span><span class="n">res</span><span class="o">.</span><span class="n">json</span><span class="p">)</span>
<span class="go">{'researchers': [{'id': 'ur.01332073522.49',</span>
<span class="go"> 'count': 75,</span>
<span class="go"> 'last_name': 'White',</span>
<span class="go"> 'first_name': 'Nicholas J'},</span>
<span class="go">{'id': 'ur.01343654360.43',</span>
<span class="go"> 'count': 59,</span>
<span class="go"> 'last_name': 'Marsh',</span>
<span class="go"> 'first_name': 'Kevin'},</span>
<span class="go">.............</span>
<span class="go">],</span>
<span class="go">'_stats': {'total_count': 8735}}</span>
</pre></div>
</div>
<section id="about-dimensions-analytics-api">
<h2>About Dimensions Analytics API<a class="headerlink" href="#about-dimensions-analytics-api" title="Permalink to this headline"></a></h2>
<p>The <a class="reference external" href="https://www.dimensions.ai/dimensions-apis/">Dimensions Analytics API</a> supports extraction of Dimensions data for use in complex analyses and visualizations or the building of analytical tools and reporting templates. The API uses an intuitive <a class="reference external" href="https://docs.dimensions.ai/dsl">query language</a> specifically developed for Dimensions data. You can retrieve, aggregate, and sort data from highly specific requests in a single API call. Additional services like text categorization are also available.</p>
<p>Digital Science’s <a class="reference external" href="https://app.dimensions.ai/">Dimensions</a> is a linked-research data platform that allows to explore the connections between more than 150 million records including grants, publications, clinical trials, patents and policy documents.</p>
<p>For more information about the Dimensions Analytics API, see also:</p>
<ul class="simple">
<li><p>The <a class="reference external" href="https://api-lab.dimensions.ai/">Dimensions API Lab</a> , an open source collection of jupyter notebooks tutorials</p></li>
<li><p>The official <a class="reference external" href="https://docs.dimensions.ai/dsl/">Dimensions API Documentation</a></p></li>
</ul>
<div class="toctree-wrapper compound">
<p class="caption" role="heading"><span class="caption-text">Contents</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="getting-started.html">Getting Started with Dimcli</a><ul>
<li class="toctree-l2"><a class="reference internal" href="getting-started.html#in-a-nutshell">In a nutshell</a></li>
<li class="toctree-l2"><a class="reference internal" href="getting-started.html#installation">Installation</a></li>
<li class="toctree-l2"><a class="reference internal" href="getting-started.html#authentication">Authentication</a><ul>
<li class="toctree-l3"><a class="reference internal" href="getting-started.html#creating-a-configuration-file-using-the-helper-script-recommended">Creating a configuration file using the helper script (recommended)</a></li>
<li class="toctree-l3"><a class="reference internal" href="getting-started.html#creating-a-configuration-file-manually">Creating a configuration file manually</a></li>
<li class="toctree-l3"><a class="reference internal" href="getting-started.html#overriding-credentials-at-runtime-e-g-with-jupyter-notebooks">Overriding credentials at runtime (e.g. with Jupyter Notebooks)</a></li>
<li class="toctree-l3"><a class="reference internal" href="getting-started.html#using-multiple-api-endpoints-for-advanced-users">Using multiple API endpoints (for advanced users)</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="getting-started.html#settings">Settings</a><ul>
<li class="toctree-l3"><a class="reference internal" href="getting-started.html#github-gists-token">Github Gists Token</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="getting-started.html#dimcli-as-a-python-module">Dimcli as a Python module</a></li>
<li class="toctree-l2"><a class="reference internal" href="getting-started.html#dimcli-as-a-command-line-interface">Dimcli as a Command Line Interface</a></li>
<li class="toctree-l2"><a class="reference internal" href="getting-started.html#dimcli-with-jupyter-notebooks">Dimcli with Jupyter Notebooks</a></li>
<li class="toctree-l2"><a class="reference internal" href="getting-started.html#changelog">Changelog</a></li>
<li class="toctree-l2"><a class="reference internal" href="getting-started.html#comments-bug-reports">Comments, bug reports</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="modules.html">Modules Reference</a><ul>
<li class="toctree-l2"><a class="reference internal" href="modules.html#module-dimcli.__init__">dimcli.login</a></li>
<li class="toctree-l2"><a class="reference internal" href="modules.html#module-dimcli.core.api">dimcli.core.api</a></li>
<li class="toctree-l2"><a class="reference internal" href="modules.html#module-dimcli.core.functions">dimcli.core.functions</a></li>
<li class="toctree-l2"><a class="reference internal" href="modules.html#module-dimcli.utils.dim_utils">dimcli.utils.dimensions</a></li>
<li class="toctree-l2"><a class="reference internal" href="modules.html#module-dimcli.utils.misc_utils">dimcli.utils.miscellaneous</a></li>
<li class="toctree-l2"><a class="reference internal" href="modules.html#module-dimcli.utils.converters">dimcli.utils.converters</a></li>
<li class="toctree-l2"><a class="reference internal" href="modules.html#module-dimcli.jupyter.magics">dimcli.jupyter.magics</a></li>
</ul>
</li>
</ul>
</div>
</section>
</section>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="getting-started.html" class="btn btn-neutral float-right" title="Getting Started with Dimcli" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr/>
<div role="contentinfo">
<p>© Copyright 2020-2021, Digital Science.</p>
</div>
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>