forskai 0.1.0__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- forskai-0.1.0/.gitignore +4 -0
- forskai-0.1.0/LICENSE +12 -0
- forskai-0.1.0/PKG-INFO +41 -0
- forskai-0.1.0/README.md +21 -0
- forskai-0.1.0/pyproject.toml +32 -0
- forskai-0.1.0/src/forskai/__init__.py +34 -0
forskai-0.1.0/.gitignore
ADDED
forskai-0.1.0/LICENSE
ADDED
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
Copyright (c) 2026 Heidi Helena Andersén / Vahtian. All rights reserved.
|
|
2
|
+
|
|
3
|
+
This package ("forskai") and its contents are proprietary. No license is granted to use, copy,
|
|
4
|
+
modify, or distribute the recoverability engine or any ForskAI service component. The name-claim
|
|
5
|
+
and public entry-point code in this distribution may not be repackaged or redistributed without
|
|
6
|
+
written permission.
|
|
7
|
+
|
|
8
|
+
ForskAI provides design evidence under stated assumptions. It is not validity about people, not a
|
|
9
|
+
guarantee of results, and not a medical device. It does not provide clinical, diagnostic, or
|
|
10
|
+
medical advice.
|
|
11
|
+
|
|
12
|
+
Contact: pilot@forskai.com
|
forskai-0.1.0/PKG-INFO
ADDED
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: forskai
|
|
3
|
+
Version: 0.1.0
|
|
4
|
+
Summary: Recoverability testing for research design — the public entry point to the ForskAI Design Pilot.
|
|
5
|
+
Project-URL: Homepage, https://www.forskai.com
|
|
6
|
+
Project-URL: Example report, https://www.forskai.com/example
|
|
7
|
+
Project-URL: Source, https://github.com/heidihelena/forskai
|
|
8
|
+
Author-email: Heidi Helena Andersén <pilot@forskai.com>
|
|
9
|
+
License: LicenseRef-Proprietary
|
|
10
|
+
License-File: LICENSE
|
|
11
|
+
Keywords: estimand,power analysis,recoverability,research design,simulation,study design
|
|
12
|
+
Classifier: Development Status :: 2 - Pre-Alpha
|
|
13
|
+
Classifier: Intended Audience :: Science/Research
|
|
14
|
+
Classifier: License :: Other/Proprietary License
|
|
15
|
+
Classifier: Operating System :: OS Independent
|
|
16
|
+
Classifier: Programming Language :: Python :: 3
|
|
17
|
+
Classifier: Topic :: Scientific/Engineering
|
|
18
|
+
Requires-Python: >=3.9
|
|
19
|
+
Description-Content-Type: text/markdown
|
|
20
|
+
|
|
21
|
+
# forskai
|
|
22
|
+
|
|
23
|
+
**Recoverability testing for research design.** ForskAI examines whether a planned study can
|
|
24
|
+
recover the effect it is meant to detect — *before* data collection begins. A passed design test is
|
|
25
|
+
design evidence under stated assumptions; it is never validity about people, and never a guarantee
|
|
26
|
+
of results.
|
|
27
|
+
|
|
28
|
+
This package is the **public entry point** for ForskAI. It currently carries the project's identity
|
|
29
|
+
and points to the service; it will grow into the thin client for the hosted engine. The
|
|
30
|
+
recoverability engine itself is not distributed here.
|
|
31
|
+
|
|
32
|
+
```python
|
|
33
|
+
import forskai
|
|
34
|
+
forskai.info()
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
- Service: https://www.forskai.com
|
|
38
|
+
- Example report: https://www.forskai.com/example
|
|
39
|
+
|
|
40
|
+
ForskAI is a product of Vahtian. It does not provide clinical, diagnostic, or medical advice and is
|
|
41
|
+
not a medical device.
|
forskai-0.1.0/README.md
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
# forskai
|
|
2
|
+
|
|
3
|
+
**Recoverability testing for research design.** ForskAI examines whether a planned study can
|
|
4
|
+
recover the effect it is meant to detect — *before* data collection begins. A passed design test is
|
|
5
|
+
design evidence under stated assumptions; it is never validity about people, and never a guarantee
|
|
6
|
+
of results.
|
|
7
|
+
|
|
8
|
+
This package is the **public entry point** for ForskAI. It currently carries the project's identity
|
|
9
|
+
and points to the service; it will grow into the thin client for the hosted engine. The
|
|
10
|
+
recoverability engine itself is not distributed here.
|
|
11
|
+
|
|
12
|
+
```python
|
|
13
|
+
import forskai
|
|
14
|
+
forskai.info()
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
- Service: https://www.forskai.com
|
|
18
|
+
- Example report: https://www.forskai.com/example
|
|
19
|
+
|
|
20
|
+
ForskAI is a product of Vahtian. It does not provide clinical, diagnostic, or medical advice and is
|
|
21
|
+
not a medical device.
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
[build-system]
|
|
2
|
+
requires = ["hatchling"]
|
|
3
|
+
build-backend = "hatchling.build"
|
|
4
|
+
|
|
5
|
+
[project]
|
|
6
|
+
name = "forskai"
|
|
7
|
+
version = "0.1.0"
|
|
8
|
+
description = "Recoverability testing for research design — the public entry point to the ForskAI Design Pilot."
|
|
9
|
+
readme = "README.md"
|
|
10
|
+
requires-python = ">=3.9"
|
|
11
|
+
license = { text = "LicenseRef-Proprietary" }
|
|
12
|
+
authors = [{ name = "Heidi Helena Andersén", email = "pilot@forskai.com" }]
|
|
13
|
+
keywords = ["research design", "recoverability", "study design", "power analysis", "simulation", "estimand"]
|
|
14
|
+
classifiers = [
|
|
15
|
+
"Development Status :: 2 - Pre-Alpha",
|
|
16
|
+
"Intended Audience :: Science/Research",
|
|
17
|
+
"License :: Other/Proprietary License",
|
|
18
|
+
"Operating System :: OS Independent",
|
|
19
|
+
"Programming Language :: Python :: 3",
|
|
20
|
+
"Topic :: Scientific/Engineering",
|
|
21
|
+
]
|
|
22
|
+
|
|
23
|
+
[project.urls]
|
|
24
|
+
Homepage = "https://www.forskai.com"
|
|
25
|
+
"Example report" = "https://www.forskai.com/example"
|
|
26
|
+
Source = "https://github.com/heidihelena/forskai"
|
|
27
|
+
|
|
28
|
+
[tool.hatch.build.targets.wheel]
|
|
29
|
+
packages = ["src/forskai"]
|
|
30
|
+
|
|
31
|
+
[tool.hatch.build.targets.sdist]
|
|
32
|
+
include = ["src/forskai", "README.md", "LICENSE"]
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
"""forskai — recoverability testing for research design.
|
|
2
|
+
|
|
3
|
+
Recoverability testing examines whether a planned study can recover the effect it is meant to
|
|
4
|
+
detect, *before* data collection begins — design evidence under stated assumptions, never a
|
|
5
|
+
guarantee of results. The Design Pilot service runs at https://www.forskai.com.
|
|
6
|
+
|
|
7
|
+
This package is the public entry point for ForskAI. It will grow into the thin client for the
|
|
8
|
+
hosted engine; for now it carries the project's identity and points to the service. The
|
|
9
|
+
recoverability engine itself is not distributed here.
|
|
10
|
+
"""
|
|
11
|
+
|
|
12
|
+
from __future__ import annotations
|
|
13
|
+
|
|
14
|
+
__version__ = "0.1.0"
|
|
15
|
+
|
|
16
|
+
HOMEPAGE = "https://www.forskai.com"
|
|
17
|
+
EXAMPLE_REPORT = "https://www.forskai.com/example"
|
|
18
|
+
|
|
19
|
+
|
|
20
|
+
def info() -> dict:
|
|
21
|
+
"""Return where to find ForskAI and what it does."""
|
|
22
|
+
return {
|
|
23
|
+
"name": "forskai",
|
|
24
|
+
"version": __version__,
|
|
25
|
+
"what": (
|
|
26
|
+
"Recoverability testing for research design — design evidence before data collection, "
|
|
27
|
+
"not a guarantee of results."
|
|
28
|
+
),
|
|
29
|
+
"service": HOMEPAGE,
|
|
30
|
+
"example_report": EXAMPLE_REPORT,
|
|
31
|
+
}
|
|
32
|
+
|
|
33
|
+
|
|
34
|
+
__all__ = ["__version__", "HOMEPAGE", "EXAMPLE_REPORT", "info"]
|