Name | sosia JSON |
Version |
1.0
JSON |
| download |
home_page | None |
Summary | Find control groups for academics in Scopus |
upload_time | 2024-11-24 20:57:45 |
maintainer | None |
docs_url | None |
author | None |
requires_python | None |
license | MIT |
keywords |
sosia
control groups
research
|
VCS |
 |
bugtrack_url |
|
requirements |
No requirements were recorded.
|
Travis-CI |
No Travis.
|
coveralls test coverage |
No coveralls.
|
sosia
=====
Match authors automatically in Scopus on-line
Documentation: https://sosia.readthedocs.io
Development: https://github.com/sosia-dev/sosia
.. image:: https://badge.fury.io/py/sosia.svg
:target: https://badge.fury.io/py/sosia
.. image:: https://readthedocs.org/projects/sosia/badge/?version=latest
:target: https://readthedocs.org/projects/sosia/badge/?version=latest
.. image:: https://img.shields.io/pypi/pyversions/sosia.svg
:target: https://img.shields.io/pypi/pyversions/sosia.svg
.. image:: https://img.shields.io/pypi/l/sosia.svg
:target: https://img.shields.io/pypi/l/sosia.svg
.. image:: https://api.codeclimate.com/v1/badges/3e10a47fefae831b973a/maintainability
:target: https://codeclimate.com/github/sosia-dev/sosia/maintainability
Installation
============
Install stable version from PyPI:
.. code:: bash
pip install sosia
or development version from GitHub repository:
.. code:: bash
pip install git+https://github.com/sosia-dev/sosia
Functioning
===========
sosia performs a series of queries in the Scopus database using the `pybliometrics package
<http://pybliometrics.readthedocs.io/>`_. After configuring your local pybliometrics (providing access credentials and eventually setting cache directories), you are ready to use sosia:
.. inclusion-marker-start
.. code-block:: python
>>> import sosia
>>>
>>> # You need the Scopus ID and the year, optionally set a database path
>>> stefano = sosia.Original(55208373700, 2018)
>>> # Sources similiar to those stefano publishes in
>>> stefano.define_search_sources()
>>> # Authors publishing in search sources every 2 years
>>> stefano.identify_candidates_from_sources(first_year_margin=1, chunk_size=2)
>>> # Find candidates whose characteristics fall within margins
>>> stefano.filter_candidates(same_discipline=True, first_year_margin=1,
>>> pub_margin=0.2, cits_margin=0.2,
>>> coauth_margin=0.15)
>>> print(stefano.matches)
>>> [55567912500]
>>> # Optional step to provide additional information
>>> stefano.inform_matches()
>>> print(stefano.matches[0])
Match(ID=55567912500, name='Eling, Katrin', first_name='Katrin',
surname='Eling', first_year=2013, last_year=2018, num_coauthors=9,
num_publications=8, num_citations=56, subjects=['BUSI', 'COMP', 'ENGI'],
affiliation_country='Netherlands', affiliation_id='60032882',
affiliation_name='Technische Universiteit Eindhoven',
affiliation_type='univ', language='eng', num_cited_refs=0)
.. inclusion-marker-end
Change log
==========
Please see `CHANGES.rst <./meta/CHANGES.rst>`_.
Contributing
============
Please see `CONTRIBUTING.rst <CONTRIBUTING.rst>`_. For the list of contributors see
`AUTHORS.rst <./meta/AUTHORS.rst>`_.
License
=======
MIT License; see `LICENSE <LICENSE>`_.
Raw data
{
"_id": null,
"home_page": null,
"name": "sosia",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": "\"Michael E. Rose\" <Michael.Ernst.Rose@gmail.com>",
"keywords": "sosia, control groups, research",
"author": null,
"author_email": "\"Michael E. Rose and Stefano H. Baruffaldi\" <Michael.Ernst.Rose@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/3a/68/a51fb1162b112804cf8600ec95683d4d660f2029b8b2f7978c4c8d978caa/sosia-1.0.tar.gz",
"platform": null,
"description": "sosia\r\n=====\r\n\r\nMatch authors automatically in Scopus on-line\r\n\r\nDocumentation: https://sosia.readthedocs.io\r\n\r\nDevelopment: https://github.com/sosia-dev/sosia\r\n\r\n.. image:: https://badge.fury.io/py/sosia.svg\r\n :target: https://badge.fury.io/py/sosia\r\n\r\n.. image:: https://readthedocs.org/projects/sosia/badge/?version=latest\r\n :target: https://readthedocs.org/projects/sosia/badge/?version=latest\r\n\r\n.. image:: https://img.shields.io/pypi/pyversions/sosia.svg\r\n :target: https://img.shields.io/pypi/pyversions/sosia.svg\r\n\r\n.. image:: https://img.shields.io/pypi/l/sosia.svg\r\n :target: https://img.shields.io/pypi/l/sosia.svg\r\n\r\n.. image:: https://api.codeclimate.com/v1/badges/3e10a47fefae831b973a/maintainability\r\n :target: https://codeclimate.com/github/sosia-dev/sosia/maintainability\r\n\r\nInstallation\r\n============\r\n\r\nInstall stable version from PyPI:\r\n\r\n.. code:: bash\r\n\r\n pip install sosia\r\n\r\nor development version from GitHub repository:\r\n\r\n.. code:: bash\r\n\r\n pip install git+https://github.com/sosia-dev/sosia\r\n\r\nFunctioning\r\n===========\r\n\r\nsosia performs a series of queries in the Scopus database using the `pybliometrics package \r\n<http://pybliometrics.readthedocs.io/>`_. After configuring your local pybliometrics (providing access credentials and eventually setting cache directories), you are ready to use sosia:\r\n\r\n.. inclusion-marker-start\r\n.. code-block:: python\r\n\r\n >>> import sosia\r\n >>> \r\n >>> # You need the Scopus ID and the year, optionally set a database path\r\n >>> stefano = sosia.Original(55208373700, 2018)\r\n >>> # Sources similiar to those stefano publishes in\r\n >>> stefano.define_search_sources()\r\n >>> # Authors publishing in search sources every 2 years\r\n >>> stefano.identify_candidates_from_sources(first_year_margin=1, chunk_size=2)\r\n >>> # Find candidates whose characteristics fall within margins\r\n >>> stefano.filter_candidates(same_discipline=True, first_year_margin=1,\r\n >>> pub_margin=0.2, cits_margin=0.2,\r\n >>> coauth_margin=0.15)\r\n >>> print(stefano.matches)\r\n >>> [55567912500]\r\n >>> # Optional step to provide additional information\r\n >>> stefano.inform_matches()\r\n >>> print(stefano.matches[0])\r\n Match(ID=55567912500, name='Eling, Katrin', first_name='Katrin',\r\n surname='Eling', first_year=2013, last_year=2018, num_coauthors=9,\r\n num_publications=8, num_citations=56, subjects=['BUSI', 'COMP', 'ENGI'],\r\n affiliation_country='Netherlands', affiliation_id='60032882',\r\n affiliation_name='Technische Universiteit Eindhoven',\r\n affiliation_type='univ', language='eng', num_cited_refs=0)\r\n\r\n.. inclusion-marker-end\r\n\r\nChange log\r\n==========\r\n\r\nPlease see `CHANGES.rst <./meta/CHANGES.rst>`_.\r\n\r\nContributing\r\n============\r\n\r\nPlease see `CONTRIBUTING.rst <CONTRIBUTING.rst>`_. For the list of contributors see\r\n`AUTHORS.rst <./meta/AUTHORS.rst>`_.\r\n\r\nLicense\r\n=======\r\n\r\nMIT License; see `LICENSE <LICENSE>`_.\r\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Find control groups for academics in Scopus",
"version": "1.0",
"project_urls": {
"Bug Tracker": "https://github.com/sosia-dev/sosia/issues",
"Documentation (latest)": "https://sosia.readthedocs.io/en/latest/",
"Documentation (stable)": "https://sosia.readthedocs.io/en/stable/",
"Homepage": "https://github.com/sosia-dev/sosia"
},
"split_keywords": [
"sosia",
" control groups",
" research"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "1336b27f21e31a3e4071239c6ec29d507d5c0ddef319f45ca84304bc0752502a",
"md5": "63b3bb6c99aa592a7cc06af1e5523c32",
"sha256": "d530e8bed80e1984816a70cf458a6ca739efc3535b8b8aa77afc1320e95dfc33"
},
"downloads": -1,
"filename": "sosia-1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "63b3bb6c99aa592a7cc06af1e5523c32",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 41956,
"upload_time": "2024-11-24T20:57:42",
"upload_time_iso_8601": "2024-11-24T20:57:42.253921Z",
"url": "https://files.pythonhosted.org/packages/13/36/b27f21e31a3e4071239c6ec29d507d5c0ddef319f45ca84304bc0752502a/sosia-1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "3a68a51fb1162b112804cf8600ec95683d4d660f2029b8b2f7978c4c8d978caa",
"md5": "03da4bef236c41db12082bf49fb07388",
"sha256": "33960a3e2cab58faca3e3ecdb998b3045b882d528971484337b62027c1ab0905"
},
"downloads": -1,
"filename": "sosia-1.0.tar.gz",
"has_sig": false,
"md5_digest": "03da4bef236c41db12082bf49fb07388",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 52387,
"upload_time": "2024-11-24T20:57:45",
"upload_time_iso_8601": "2024-11-24T20:57:45.300943Z",
"url": "https://files.pythonhosted.org/packages/3a/68/a51fb1162b112804cf8600ec95683d4d660f2029b8b2f7978c4c8d978caa/sosia-1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-24 20:57:45",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "sosia-dev",
"github_project": "sosia",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "sosia"
}