PubChem View API¶
The PubChem View module provides access to experimental property data from PubChem's PUG View service. This includes extraction of experimental values, units, and comprehensive reference information.
provesid.pubchemview
¶
Classes¶
PropertyData
dataclass
¶
Data structure for holding extracted property information
Source code in src/provesid/pubchemview.py
11 12 13 14 15 16 17 18 19 20 |
|
PubChemViewError
¶
Bases: Exception
Base exception class for PubChem View API errors
Source code in src/provesid/pubchemview.py
23 24 25 |
|
PubChemViewNotFoundError
¶
Bases: PubChemViewError
Exception raised when compound or property is not found
Source code in src/provesid/pubchemview.py
28 29 30 |
|
PubChemView
¶
A class that uses PUG View for extracting properties reported for each substance in PubChem but are not included in the standard API response for substance, compound, assay, etc. The response to these queries is a large JSON object that requires some post-processing to extract the relevant information.
Source code in src/provesid/pubchemview.py
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 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 |
|
Functions¶
__init__(base_url='https://pubchem.ncbi.nlm.nih.gov/rest/pug_view', timeout=30, max_retries=3, backoff_factor=1.0)
¶
Initialize PubChemView API client
Parameters:
Name | Type | Description | Default |
---|---|---|---|
base_url
|
str
|
Base URL for PubChem PUG View API |
'https://pubchem.ncbi.nlm.nih.gov/rest/pug_view'
|
timeout
|
int
|
Request timeout in seconds |
30
|
max_retries
|
int
|
Maximum number of retry attempts |
3
|
backoff_factor
|
float
|
Backoff factor for retries |
1.0
|
Source code in src/provesid/pubchemview.py
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 |
|
get_experimental_properties(cid)
¶
Get all experimental properties for a compound
Parameters:
Name | Type | Description | Default |
---|---|---|---|
cid
|
Union[int, str]
|
PubChem Compound ID |
required |
Returns:
Type | Description |
---|---|
Dict[str, Any]
|
Raw JSON response containing all experimental properties |
Source code in src/provesid/pubchemview.py
157 158 159 160 161 162 163 164 165 166 167 168 |
|
get_property(cid, property_name)
¶
Get a specific property for a compound
Parameters:
Name | Type | Description | Default |
---|---|---|---|
cid
|
Union[int, str]
|
PubChem Compound ID |
required |
property_name
|
str
|
Name of the property (can be with spaces or plus signs) |
required |
Returns:
Type | Description |
---|---|
Dict[str, Any]
|
Raw JSON response for the specific property |
Source code in src/provesid/pubchemview.py
170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 |
|
extract_property_data(cid, property_name)
¶
Extract structured property data for a specific property
Parameters:
Name | Type | Description | Default |
---|---|---|---|
cid
|
Union[int, str]
|
PubChem Compound ID |
required |
property_name
|
str
|
Name of the property to extract |
required |
Returns:
Type | Description |
---|---|
List[PropertyData]
|
List of PropertyData objects with extracted information |
Source code in src/provesid/pubchemview.py
267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 |
|
extract_all_experimental_properties(cid)
¶
Extract all experimental properties for a compound in structured format
Parameters:
Name | Type | Description | Default |
---|---|---|---|
cid
|
Union[int, str]
|
PubChem Compound ID |
required |
Returns:
Type | Description |
---|---|
Dict[str, List[PropertyData]]
|
Dictionary mapping property names to lists of PropertyData objects |
Source code in src/provesid/pubchemview.py
321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 |
|
get_available_properties(cid)
¶
Get list of available experimental properties for a compound
Parameters:
Name | Type | Description | Default |
---|---|---|---|
cid
|
Union[int, str]
|
PubChem Compound ID |
required |
Returns:
Type | Description |
---|---|
List[str]
|
List of available property names |
Source code in src/provesid/pubchemview.py
379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 |
|
get_property_summary(cid, property_name)
¶
Get a summary of a property including all values, units, and references
Parameters:
Name | Type | Description | Default |
---|---|---|---|
cid
|
Union[int, str]
|
PubChem Compound ID |
required |
property_name
|
str
|
Name of the property |
required |
Returns:
Type | Description |
---|---|
Dict[str, Any]
|
Dictionary with property summary |
Source code in src/provesid/pubchemview.py
395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 |
|
get_melting_point(cid)
¶
Get melting point data for a compound
Source code in src/provesid/pubchemview.py
423 424 425 |
|
get_boiling_point(cid)
¶
Get boiling point data for a compound
Source code in src/provesid/pubchemview.py
427 428 429 |
|
get_density(cid)
¶
Get density data for a compound
Source code in src/provesid/pubchemview.py
431 432 433 |
|
get_solubility(cid)
¶
Get solubility data for a compound
Source code in src/provesid/pubchemview.py
435 436 437 |
|
get_flash_point(cid)
¶
Get flash point data for a compound
Source code in src/provesid/pubchemview.py
439 440 441 |
|
get_vapor_pressure(cid)
¶
Get vapor pressure data for a compound
Source code in src/provesid/pubchemview.py
443 444 445 |
|
get_viscosity(cid)
¶
Get viscosity data for a compound
Source code in src/provesid/pubchemview.py
447 448 449 |
|
get_logp(cid)
¶
Get LogP data for a compound
Source code in src/provesid/pubchemview.py
451 452 453 |
|
get_refractive_index(cid)
¶
Get refractive index data for a compound
Source code in src/provesid/pubchemview.py
455 456 457 |
|
batch_extract_properties(cid, property_names)
¶
Extract multiple properties for a compound
Parameters:
Name | Type | Description | Default |
---|---|---|---|
cid
|
Union[int, str]
|
PubChem Compound ID |
required |
property_names
|
List[str]
|
List of property names to extract |
required |
Returns:
Type | Description |
---|---|
Dict[str, List[PropertyData]]
|
Dictionary mapping property names to PropertyData lists |
Source code in src/provesid/pubchemview.py
459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 |
|
export_properties_to_dict(property_data_list)
¶
Convert PropertyData objects to dictionaries for easy serialization
Parameters:
Name | Type | Description | Default |
---|---|---|---|
property_data_list
|
List[PropertyData]
|
List of PropertyData objects |
required |
Returns:
Type | Description |
---|---|
List[Dict[str, Any]]
|
List of dictionaries |
Source code in src/provesid/pubchemview.py
481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 |
|
get_property_table(cid, property_name)
¶
Get a comprehensive table of property data with full reference information
Parameters:
Name | Type | Description | Default |
---|---|---|---|
cid
|
Union[int, str]
|
PubChem Compound ID |
required |
property_name
|
str
|
Name of the experimental property |
required |
Returns:
Type | Description |
---|---|
DataFrame
|
pandas DataFrame with columns: CID, StringWithMarkup, ExperimentalValue, Unit, Temperature, Conditions, FullReference |
Source code in src/provesid/pubchemview.py
505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 |
|
Functions¶
get_experimental_property(cid, property_name)
¶
Convenience function to get experimental property data
Parameters:
Name | Type | Description | Default |
---|---|---|---|
cid
|
Union[int, str]
|
PubChem Compound ID |
required |
property_name
|
str
|
Name of the property |
required |
Returns:
Type | Description |
---|---|
List[PropertyData]
|
List of PropertyData objects |
Source code in src/provesid/pubchemview.py
997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 |
|
get_all_experimental_properties(cid)
¶
Convenience function to get all experimental properties
Parameters:
Name | Type | Description | Default |
---|---|---|---|
cid
|
Union[int, str]
|
PubChem Compound ID |
required |
Returns:
Type | Description |
---|---|
Dict[str, List[PropertyData]]
|
Dictionary mapping property names to PropertyData lists |
Source code in src/provesid/pubchemview.py
1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 |
|
get_property_values_only(cid, property_name)
¶
Convenience function to get just the property values as strings
Parameters:
Name | Type | Description | Default |
---|---|---|---|
cid
|
Union[int, str]
|
PubChem Compound ID |
required |
property_name
|
str
|
Name of the property |
required |
Returns:
Type | Description |
---|---|
List[str]
|
List of property value strings |
Source code in src/provesid/pubchemview.py
1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 |
|
get_property_table(cid, property_name)
¶
Convenience function to get a comprehensive property table with full references
Parameters:
Name | Type | Description | Default |
---|---|---|---|
cid
|
Union[int, str]
|
PubChem Compound ID |
required |
property_name
|
str
|
Name of the experimental property |
required |
Returns:
Type | Description |
---|---|
DataFrame
|
pandas DataFrame with columns: CID, StringWithMarkup, ExperimentalValue, Unit, FullReference |
Source code in src/provesid/pubchemview.py
1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 |
|
Quick Start¶
from provesid import PubChemView
from provesid.pubchemview import get_experimental_properties_table
# Initialize the view client
view = PubChemView()
# Get experimental melting points for aspirin (CID 2244)
properties = view.get_experimental_properties(2244, 'Melting Point')
for prop in properties:
print(f"Value: {prop.value} {prop.unit}")
print(f"Reference: {prop.reference_title}")
# Get a structured DataFrame
df = view.experimental_properties_to_dataframe(2244, 'Melting Point')
print(df.head())
# Use the convenience function for a complete table
table = get_experimental_properties_table(2244, 'Boiling Point')
print(table)
Available Property Types¶
The PubChem View service provides access to various experimental properties:
Physical Properties¶
- Melting Point - Melting point temperatures
- Boiling Point - Boiling point temperatures
- Density - Density measurements
- Vapor Pressure - Vapor pressure data
- Solubility - Solubility in various solvents
- LogP - Partition coefficient data
- Viscosity - Viscosity measurements
- Refractive Index - Refractive index values
Spectroscopic Properties¶
- UV/Vis Spectrum - UV-Visible spectroscopy data
- IR Spectrum - Infrared spectroscopy data
- NMR Spectrum - Nuclear magnetic resonance data
- Mass Spectrum - Mass spectrometry data
Safety and Toxicity¶
- Flash Point - Flash point temperatures
- Auto-Ignition Temperature - Auto-ignition data
- LD50 - Lethal dose data
- LC50 - Lethal concentration data
Data Structures¶
PropertyData Class¶
The PropertyData
dataclass represents a single experimental property measurement:
@dataclass
class PropertyData:
cid: int
heading: str
string_with_markup: str
value: Optional[str]
unit: Optional[str]
reference_number: Optional[str]
reference_title: Optional[str]
reference_authors: Optional[str]
reference_journal: Optional[str]
reference_year: Optional[str]
reference_doi: Optional[str]
reference_pmid: Optional[str]
full_reference: Optional[str]
Fields:
- cid
: PubChem Compound ID
- heading
: Property type (e.g., "Melting Point")
- string_with_markup
: Original text with markup
- value
: Extracted numeric/text value
- unit
: Unit of measurement
- reference_*
: Citation information
- full_reference
: Complete formatted reference
Advanced Usage¶
Custom Value Parsing¶
The module includes sophisticated value parsing that handles:
# Complex value strings
examples = [
"139-140 °C", # Range values
"25.5 ± 0.2 °C", # Values with uncertainty
"< 100 °C", # Comparison operators
"decomp. at 180 °C", # Qualitative descriptions
"760 mmHg at 20 °C" # Conditional values
]
# The parser extracts the main numeric value
for example in examples:
# Internal parsing would extract the primary value
pass
Reference Information Extraction¶
Complete bibliographic information is extracted and structured:
# Get properties with full reference details
properties = view.get_experimental_properties(2244, 'Melting Point')
for prop in properties:
if prop.reference_doi:
print(f"DOI: {prop.reference_doi}")
if prop.reference_pmid:
print(f"PubMed ID: {prop.reference_pmid}")
if prop.full_reference:
print(f"Full citation: {prop.full_reference}")
DataFrame Operations¶
Convert to pandas DataFrame for data analysis:
import pandas as pd
# Get DataFrame with all experimental data
df = view.experimental_properties_to_dataframe(2244, 'Solubility')
# Filter by specific units
water_solubility = df[df['Unit'].str.contains('g/L', na=False)]
# Group by reference source
by_source = df.groupby('Reference').agg({
'Value': ['count', 'mean'],
'Unit': lambda x: list(x.unique())
})
# Export to CSV
df.to_csv('solubility_data.csv', index=False)
Error Handling¶
The module provides specific exception classes:
from provesid.pubchemview import PubChemViewError, PubChemViewNotFoundError
try:
properties = view.get_experimental_properties(999999, 'Melting Point')
except PubChemViewNotFoundError:
print("Compound or property not found")
except PubChemViewError as e:
print(f"API error: {e}")
Batch Processing¶
Process multiple compounds efficiently:
def batch_extract_properties(cids, property_type):
"""Extract properties for multiple compounds"""
results = {}
view = PubChemView()
for cid in cids:
try:
df = view.experimental_properties_to_dataframe(cid, property_type)
if not df.empty:
results[cid] = {
'count': len(df),
'mean_value': df['Value'].mean() if df['Value'].notna().any() else None,
'units': df['Unit'].unique().tolist()
}
except Exception as e:
results[cid] = {'error': str(e)}
return results
# Process multiple compounds
cids = [2244, 2519, 3672] # Aspirin, Caffeine, Ibuprofen
melting_data = batch_extract_properties(cids, 'Melting Point')
Integration with Other APIs¶
Combine with PubChem compound data:
from provesid import PubChemAPI, PubChemView
def comprehensive_compound_analysis(cid):
"""Get both computed and experimental data"""
api = PubChemAPI()
view = PubChemView()
# Get computed properties
computed = api.get_compound_properties(
[cid],
['MolecularWeight', 'MolecularFormula', 'ConnectivitySMILES']
)
# Get experimental properties
experimental = {}
for prop_type in ['Melting Point', 'Boiling Point', 'Density']:
try:
df = view.experimental_properties_to_dataframe(cid, prop_type)
if not df.empty:
experimental[prop_type] = df
except:
pass
return {
'computed': computed,
'experimental': experimental
}
# Analyze aspirin
analysis = comprehensive_compound_analysis(2244)
Performance Considerations¶
Rate Limiting¶
The PubChemView client includes automatic rate limiting:
# Adjust request frequency for large batch jobs
view = PubChemView(pause_time=1.0) # 1 second between requests
# For development/testing with faster requests
view_fast = PubChemView(pause_time=0.1) # 100ms between requests
Caching¶
Consider implementing caching for frequently accessed data:
import pickle
from pathlib import Path
def cached_property_extraction(cid, property_type, cache_dir='cache'):
"""Extract properties with file-based caching"""
cache_path = Path(cache_dir) / f"{cid}_{property_type}.pkl"
if cache_path.exists():
with open(cache_path, 'rb') as f:
return pickle.load(f)
# Extract fresh data
view = PubChemView()
df = view.experimental_properties_to_dataframe(cid, property_type)
# Cache the results
cache_path.parent.mkdir(exist_ok=True)
with open(cache_path, 'wb') as f:
pickle.dump(df, f)
return df
See Also¶
- PubChem API - For computed compound properties
- PubChem Tutorial - Complete tutorial with detailed examples