Skip to main content

Model-agnostic scientific-research skill (SKILL.md + reference files + IMRaD/response-to-reviewers/aims/preregistration templates) loadable into any capable LLM.

Project description

sciresearchkit

SciResearchKit logo

Python distribution of SciResearchKit, a model-agnostic Markdown skill that turns any capable LLM into a rigorous scientific-research collaborator. Eight phases, three hard rules, zero runtime.

The package bundles the full Markdown corpus (SKILL.md, ETHICS.md, thirteen reference files, four templates) and provides a small Python API for loading it into any Python-hosted LLM harness.

Install

pip install sciresearchkit

Quickstart

import sciresearchkit as srk

# The recommended system prompt: SKILL.md + ETHICS.md
prompt = srk.system_prompt()

# Individual pieces
skill    = srk.get_skill()
ethics   = srk.get_ethics()
writing  = srk.get_reference("writing-style")
imrad    = srk.get_template("imrad-paper")

# Listings
srk.list_references()   # ['analysis-and-results', 'citations', ...]
srk.list_templates()    # ['imrad-paper', 'preregistration', ...]

# Filesystem handle to the bundled corpus
srk.data_dir()          # PosixPath('.../site-packages/sciresearchkit/data')

Command line

sciresearchkit                        # print SKILL.md + ETHICS.md (system prompt)
sciresearchkit skill                  # print SKILL.md
sciresearchkit ethics                 # print ETHICS.md
sciresearchkit references             # list reference slugs
sciresearchkit reference writing-style
sciresearchkit templates              # list template slugs
sciresearchkit template imrad-paper
sciresearchkit path                   # print the bundled data directory

Pipe the prompt into a system-prompt slot:

sciresearchkit > srk_system_prompt.txt

Ethical use

SciResearchKit is a productivity aid for a human researcher. It does not replace manual human review, and it does not override any restriction on AI use imposed by a journal, conference, funder, institution, or ethics body.

Four conditions apply to every use:

  1. A qualified human reads, verifies, and signs off on every output before it is submitted or published.
  2. The user checks and complies with the target venue's, funder's, and institutional AI-use and disclosure policies. Many venues and funders prohibit AI in peer review and grant review — do not use the toolkit for tasks the applicable policy places off-limits.
  3. Do not upload confidential material (unpublished manuscripts under review, identifiable clinical data, third-party proprietary data) to a hosted AI system without the specific permission the confidentiality holder requires.
  4. Do not use the toolkit to fabricate data or citations, to bypass a required disclosure, to impersonate an author or reviewer, or to circumvent institutional or legal restrictions on AI in research.

Full statement, rationale, and disclosure template: run sciresearchkit ethics or read ETHICS.md in the repository.

License

MIT. Use of the toolkit is additionally subject to the ethical-use conditions above.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sciresearchkit-0.1.0.tar.gz (34.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

sciresearchkit-0.1.0-py3-none-any.whl (46.2 kB view details)

Uploaded Python 3

File details

Details for the file sciresearchkit-0.1.0.tar.gz.

File metadata

  • Download URL: sciresearchkit-0.1.0.tar.gz
  • Upload date:
  • Size: 34.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.14

File hashes

Hashes for sciresearchkit-0.1.0.tar.gz
Algorithm Hash digest
SHA256 bccfc1b10dbd9840041fa2f7d7a35394978e570abee318beef80398587ed5c69
MD5 f3a6823f97b21fb57dfb300a9597ac71
BLAKE2b-256 9885720948610d8fe1fa80d1e4a82fedcfcd6e8dc33aead5255e4d45d4cce788

See more details on using hashes here.

Provenance

The following attestation bundles were made for sciresearchkit-0.1.0.tar.gz:

Publisher: publish-pypi.yml on thalamuxtech/SciResearchKit

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file sciresearchkit-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: sciresearchkit-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 46.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.14

File hashes

Hashes for sciresearchkit-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 920d2790dd9dbd6f4ab0aaf558d6adafcee2d4456f5256504e091ce5d12473e3
MD5 c185587e2b86f34728363ca9fcd080b4
BLAKE2b-256 4df442ffb12d3ad54131a410054dee1fe5145a089420bd09e114ed2a76cb999f

See more details on using hashes here.

Provenance

The following attestation bundles were made for sciresearchkit-0.1.0-py3-none-any.whl:

Publisher: publish-pypi.yml on thalamuxtech/SciResearchKit

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page