Skip to main content

sudan-atlas

DOI

Official codes, names and boundaries for Sudan's 18 states, the Abyei PCA area and 189 localities, with a matcher that turns messy Arabic and English place names into official P-codes.

pip install sudan-atlas            # matcher and data
pip install "sudan-atlas[geo]"     # plus GeoDataFrames (geopandas)
from sudan_atlas import match, get_states, get_localities, get_feature

match("El Hasaheesa", state_hint="Al Gezira", level=2)
# {'pcode': 'SD15034', 'name_en': 'Al Hasahisa', 'name_ar': 'الحصاحيصا', 'level': 2,
#  'score': 0.9, 'method': 'fuzzy', 'alternatives': [...]}

get_states()              # 19 dicts: pcode, name_en, name_ar, level, parent_pcode, point
get_localities("SD15")    # the localities of one state
get_feature("SD15034", "medium")   # GeoJSON Feature dict; "detailed", "medium" or "light"

from sudan_atlas import geo        # needs the [geo] extra
geo.localities("SD02")             # GeoDataFrame, EPSG:4326

Matching

match(name, state_hint=None, level=None) tries an exact match on the official names, then a table of known spellings, then fuzzy matching. A state hint (a P-code or a state name in any spelling) limits the search to that state; level is 1 for states, 2 for localities.

It never guesses silently. When the best candidate scores below 0.82, or a second place scores almost as high, pcode is None, method is "ambiguous" or "none", and alternatives lists the best three candidates for a person to choose from. Matcher(threshold=..., margin=...) changes those settings.

The npm package (npm install sudan-atlas) returns identical results.

Citing

If you use sudan-atlas in a report, paper or product, please cite it:

Shennan, A. (2026). Sudan Atlas: official names, P-codes and boundaries for Sudan's states and localities. Zenodo. https://doi.org/10.5281/zenodo.24191932

Website, map and map-maker: https://atlas-sudan.vercel.app

Licences and sources

Code: MIT. Boundaries: CC BY 3.0 IGO, from OCHA's COD-AB for Sudan (version v03); credit "OCHA (COD-AB Sudan), via HDX; Sudan Atlas". Spellings and rules: CC BY 4.0, with sources including GeoNames (CC BY 4.0) and Wikidata (CC0); town spellings from OpenStreetMap are kept in a separate file under the ODbL (© OpenStreetMap contributors). Boundaries do not imply any opinion on the legal status of any territory. Details: https://github.com/aminshennan/sudan-atlas

Metadata

Release files for sudan-atlas 0.1.3

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for sudan-atlas 0.1.3
File Size Uploaded Provenance Actions
sudan_atlas-0.1.3.tar.gz 792.9 kB With provenance Details for sudan_atlas-0.1.3.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for sudan-atlas 0.1.3
File Interpreter ABI Platform Actions
sudan_atlas-0.1.3-py3-none-any.whl Python 3 none any Details for sudan_atlas-0.1.3-py3-none-any.whl

Total release size: 1.6 MB

Release files / sudan_atlas-0.1.3.tar.gz

Download URL sudan_atlas-0.1.3.tar.gz
Size 792.9 kB
Tags Source
SHA-256 checksum
How to use checksums
56fbd8395084c6d0fdde10bd546b23083566416dba5c92d3799d62a7fc0d7e69
BLAKE2b-256 checksum
How to use checksums
bd3b143e97118b4d9efaa59b789c5d5ea3f4f771fe1a55c5d39c7421ea96a38b
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 14, 2026.

Transparency log

Release files / sudan_atlas-0.1.3-py3-none-any.whl

Download URL sudan_atlas-0.1.3-py3-none-any.whl
Size 798.4 kB
Tags Python 3
SHA-256 checksum
How to use checksums
763f870c383d86a28e87cdadb6429c08922102012bf0f0d3e63bccd798b1bd7d
BLAKE2b-256 checksum
How to use checksums
959de4923a09092f48868c62e3b231c4458083456e41f7de968f00087518e9df
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 14, 2026.

Transparency log

Security for sudan-atlas 0.1.3

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Full provenance

Both files in this release have been uploaded with provenance metadata.

Select from 2 files

Attestation for sudan_atlas-0.1.3.tar.gz

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 14, 2026.

Transparency log

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page